Source Code
Overview
ETH Balance
0 ETH
ETH Value
$0.00
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:
CarthaVaultFactory
Compiler Version
v0.8.30+commit.73712a01
Optimization Enabled:
Yes with 200 runs
Other Settings:
prague EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {Initializable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
import {UUPSUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol";
import {ERC20Upgradeable} from "openzeppelin-contracts-upgradeable/contracts/token/ERC20/ERC20Upgradeable.sol";
import {BeaconProxy} from "openzeppelin-contracts/contracts/proxy/beacon/BeaconProxy.sol";
import {IERC20Metadata} from "openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {ICarthaVaultFactory} from "./interfaces/ICarthaVaultFactory.sol";
import {CarthaVault} from "./CarthaVault.sol";
import {CarthaParentVault} from "./CarthaParentVault.sol";
import {ICarthaParentVault} from "./interfaces/ICarthaParentVault.sol";
import {ICarthaAccessControl} from "./interfaces/ICarthaAccessControl.sol";
import {ICarthaVault} from "./interfaces/ICarthaVault.sol";
import {Roles} from "./diamond/Roles.sol";
contract CarthaVaultFactory is ICarthaVaultFactory, Initializable, UUPSUpgradeable {
/// @custom:storage-location erc7201:cartha.storage.CarthaVaultFactory
struct CarthaVaultFactoryStorage {
address beacon;
address accessControl;
VaultInfo[] vaults;
mapping(address => bool) isFactoryVault;
mapping(address => address[]) vaultsByAsset;
mapping(bytes32 => address) vaultByPoolId;
// Parent vault storage
address parentBeacon;
ParentVaultInfo[] parentVaults;
mapping(address => bool) isFactoryParent;
mapping(bytes32 => address) parentByCategory;
mapping(address => address[]) childrenByParent;
mapping(address => address) parentByChild;
}
// keccak256(abi.encode(uint256(keccak256("cartha.storage.CarthaVaultFactory")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant FACTORY_STORAGE_LOCATION =
0xdb1962c4a5690592ca7465b77ca9c0256f84cb63342b7979f63bc5799a61d100;
function _getFactoryStorage() private pure returns (CarthaVaultFactoryStorage storage $) {
assembly {
$.slot := FACTORY_STORAGE_LOCATION
}
}
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
function initialize(address beacon_, address parentBeacon_, address accessControl_) external initializer {
if (beacon_ == address(0)) revert InvalidBeacon();
if (parentBeacon_ == address(0)) revert InvalidBeacon();
if (accessControl_ == address(0)) revert InvalidAccessControl();
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
$.beacon = beacon_;
$.parentBeacon = parentBeacon_;
$.accessControl = accessControl_;
}
modifier onlyRole(uint8 role) {
_checkRole(role);
_;
}
function _checkRole(uint8 role) internal view {
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
if (!ICarthaAccessControl($.accessControl).hasRole(role, msg.sender)) {
revert Unauthorized();
}
}
function _authorizeUpgrade(address) internal override onlyRole(Roles.ADMIN) {}
function deployVault(VaultConfig calldata config) external returns (address vault) {
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
if (
!ICarthaAccessControl($.accessControl).hasRole(Roles.FACTORY, msg.sender)
&& !ICarthaAccessControl($.accessControl).hasRole(Roles.ADMIN, msg.sender)
) {
revert Unauthorized();
}
if (config.asset == address(0)) revert InvalidAsset();
if ($.vaultByPoolId[config.poolId] != address(0)) revert VaultAlreadyExists();
bytes memory initData = abi.encodeWithSelector(
CarthaVault.initialize.selector, $.accessControl, config.asset, config.poolId, config.name, config.symbol
);
vault = address(new BeaconProxy($.beacon, initData));
$.vaults
.push(
VaultInfo({vaultAddress: vault, asset: config.asset, deployedAt: block.timestamp, deployer: msg.sender})
);
$.isFactoryVault[vault] = true;
$.vaultsByAsset[config.asset].push(vault);
$.vaultByPoolId[config.poolId] = vault;
emit VaultDeployed(vault, config.asset, msg.sender, $.vaults.length - 1);
}
function deployParentVault(ParentVaultConfig calldata config) external returns (address parentVault) {
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
if (
!ICarthaAccessControl($.accessControl).hasRole(Roles.FACTORY, msg.sender)
&& !ICarthaAccessControl($.accessControl).hasRole(Roles.ADMIN, msg.sender)
) {
revert Unauthorized();
}
if (config.asset == address(0)) revert InvalidAsset();
if (config.category == bytes32(0)) revert InvalidCategory();
if ($.parentByCategory[config.category] != address(0)) revert ParentAlreadyExists();
bytes memory initData = abi.encodeWithSelector(
CarthaParentVault.initialize.selector,
config.asset,
config.category,
config.name,
config.symbol,
$.accessControl
);
parentVault = address(new BeaconProxy($.parentBeacon, initData));
$.parentVaults
.push(
ParentVaultInfo({
vaultAddress: parentVault,
asset: config.asset,
category: config.category,
deployedAt: block.timestamp,
deployer: msg.sender
})
);
$.isFactoryParent[parentVault] = true;
$.parentByCategory[config.category] = parentVault;
emit ParentVaultDeployed(parentVault, config.asset, config.category, msg.sender, $.parentVaults.length - 1);
}
function addChildToParent(address parent, address child, uint256 weight, uint256 maxAllocation)
external
onlyRole(Roles.ADMIN)
{
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
if (!$.isFactoryParent[parent]) revert InvalidParent();
if (!$.isFactoryVault[child]) revert InvalidChild();
if ($.parentByChild[child] != address(0)) revert ChildAlreadyHasParent();
if (ICarthaParentVault(parent).asset() != ICarthaVault(child).asset()) revert AssetMismatch();
$.childrenByParent[parent].push(child);
$.parentByChild[child] = parent;
ICarthaParentVault(parent).addPool(child, weight, maxAllocation);
emit ChildAddedToParent(parent, child, weight, maxAllocation);
}
function removeChildFromParent(address parent, address child) external onlyRole(Roles.ADMIN) {
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
if (!$.isFactoryParent[parent]) revert InvalidParent();
if ($.parentByChild[child] != parent) revert ChildNotInParent();
address[] storage children = $.childrenByParent[parent];
for (uint256 i = 0; i < children.length; i++) {
if (children[i] == child) {
children[i] = children[children.length - 1];
children.pop();
break;
}
}
delete $.parentByChild[child];
ICarthaParentVault(parent).removePool(child, false);
emit ChildRemovedFromParent(parent, child);
}
function beacon() external view returns (address) {
return _getFactoryStorage().beacon;
}
function accessControl() external view returns (address) {
return _getFactoryStorage().accessControl;
}
function getVaultCount() external view returns (uint256) {
return _getFactoryStorage().vaults.length;
}
function getVaultInfo(uint256 vaultId) external view returns (VaultInfo memory) {
return _getFactoryStorage().vaults[vaultId];
}
function getAllVaults() external view returns (address[] memory vaults) {
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
uint256 count = $.vaults.length;
vaults = new address[](count);
for (uint256 i = 0; i < count; i++) {
vaults[i] = $.vaults[i].vaultAddress;
}
}
function getVaultsByAsset(address asset) external view returns (address[] memory) {
return _getFactoryStorage().vaultsByAsset[asset];
}
function isFactoryVault(address vault) external view returns (bool) {
return _getFactoryStorage().isFactoryVault[vault];
}
function getDefaultConfig(address vault) external view returns (VaultConfig memory) {
ICarthaVault v = ICarthaVault(vault);
return VaultConfig({
asset: v.asset(),
poolId: v.poolId(),
name: ERC20Upgradeable(vault).name(),
symbol: ERC20Upgradeable(vault).symbol()
});
}
function parentBeacon() external view returns (address) {
return _getFactoryStorage().parentBeacon;
}
function getParentByCategory(bytes32 category) external view returns (address) {
return _getFactoryStorage().parentByCategory[category];
}
function getChildrenOfParent(address parent) external view returns (address[] memory) {
return _getFactoryStorage().childrenByParent[parent];
}
function getParentOfChild(address child) external view returns (address) {
return _getFactoryStorage().parentByChild[child];
}
function getAllParents() external view returns (address[] memory parents) {
CarthaVaultFactoryStorage storage $ = _getFactoryStorage();
uint256 count = $.parentVaults.length;
parents = new address[](count);
for (uint256 i = 0; i < count; i++) {
parents[i] = $.parentVaults[i].vaultAddress;
}
}
function isParentVault(address vault) external view returns (bool) {
return _getFactoryStorage().isFactoryParent[vault];
}
function getParentVaultCount() external view returns (uint256) {
return _getFactoryStorage().parentVaults.length;
}
function getParentVaultInfo(uint256 vaultId) external view returns (ParentVaultInfo memory) {
return _getFactoryStorage().parentVaults[vaultId];
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";// SPDX-License-Identifier: MIT
pragma solidity ^0.8.22;
import {UUPSUpgradeable} from "@openzeppelin/contracts/proxy/utils/UUPSUpgradeable.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {ContextUpgradeable} from "../../utils/ContextUpgradeable.sol";
import {IERC20Errors} from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20Upgradeable is Initializable, ContextUpgradeable, IERC20, IERC20Metadata, IERC20Errors {
/// @custom:storage-location erc7201:openzeppelin.storage.ERC20
struct ERC20Storage {
mapping(address account => uint256) _balances;
mapping(address account => mapping(address spender => uint256)) _allowances;
uint256 _totalSupply;
string _name;
string _symbol;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC20")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ERC20StorageLocation = 0x52c63247e1f47db19d5ce0460030c497f067ca4cebf71ba98eeadabe20bace00;
function _getERC20Storage() private pure returns (ERC20Storage storage $) {
assembly {
$.slot := ERC20StorageLocation
}
}
/**
* @dev Sets the values for {name} and {symbol}.
*
* Both values are immutable: they can only be set once during construction.
*/
function __ERC20_init(string memory name_, string memory symbol_) internal onlyInitializing {
__ERC20_init_unchained(name_, symbol_);
}
function __ERC20_init_unchained(string memory name_, string memory symbol_) internal onlyInitializing {
ERC20Storage storage $ = _getERC20Storage();
$._name = name_;
$._symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
ERC20Storage storage $ = _getERC20Storage();
return $._name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
ERC20Storage storage $ = _getERC20Storage();
return $._symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/// @inheritdoc IERC20
function totalSupply() public view virtual returns (uint256) {
ERC20Storage storage $ = _getERC20Storage();
return $._totalSupply;
}
/// @inheritdoc IERC20
function balanceOf(address account) public view virtual returns (uint256) {
ERC20Storage storage $ = _getERC20Storage();
return $._balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/// @inheritdoc IERC20
function allowance(address owner, address spender) public view virtual returns (uint256) {
ERC20Storage storage $ = _getERC20Storage();
return $._allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
ERC20Storage storage $ = _getERC20Storage();
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
$._totalSupply += value;
} else {
uint256 fromBalance = $._balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
$._balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
$._totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
$._balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner`'s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation sets the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the `transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
ERC20Storage storage $ = _getERC20Storage();
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
$._allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner`'s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}// 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.4.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity >=0.6.2;
import {IERC20} from "../IERC20.sol";
/**
* @dev Interface for the optional metadata functions from the ERC-20 standard.
*/
interface IERC20Metadata is IERC20 {
/**
* @dev Returns the name of the token.
*/
function name() external view returns (string memory);
/**
* @dev Returns the symbol of the token.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the decimals places of the token.
*/
function decimals() external view returns (uint8);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title ICarthaVaultFactory
* @notice Factory for deploying Cartha vaults with standardized configuration
* @dev Creates vaults for different assets (USDC, BTC, Euro USDC)
*
* Architecture:
* - Deploys beacon proxies pointing to shared implementation
* - All vaults reference single UpgradeableBeacon for implementation
* - Automatically registers vaults with CarthaAccessControl (diamond proxy)
* - Enforces consistent initialization parameters
* - Tracks all deployed vaults
*/
interface ICarthaVaultFactory {
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/
/**
* @notice Emitted when a new child vault is deployed
* @param vault Vault address
* @param asset Asset address (USDC, WBTC, etc.)
* @param deployer Address that triggered deployment
* @param vaultId Sequential vault ID
*/
event VaultDeployed(address indexed vault, address indexed asset, address deployer, uint256 vaultId);
/**
* @notice Emitted when a new parent vault is deployed
* @param parentVault Parent vault address
* @param asset Asset address
* @param category Category identifier
* @param deployer Address that triggered deployment
* @param vaultId Sequential parent vault ID
*/
event ParentVaultDeployed(
address indexed parentVault, address indexed asset, bytes32 indexed category, address deployer, uint256 vaultId
);
/**
* @notice Emitted when a child is added to a parent
* @param parent Parent vault address
* @param child Child vault address
* @param weight Allocation weight
* @param maxAllocation Maximum allocation in basis points
*/
event ChildAddedToParent(address indexed parent, address indexed child, uint256 weight, uint256 maxAllocation);
/**
* @notice Emitted when a child is removed from a parent
* @param parent Parent vault address
* @param child Child vault address
*/
event ChildRemovedFromParent(address indexed parent, address indexed child);
/*//////////////////////////////////////////////////////////////
ERRORS
//////////////////////////////////////////////////////////////*/
error InvalidAsset();
error InvalidBeacon();
error InvalidAccessControl();
error InvalidCategory();
error InvalidParent();
error InvalidChild();
error DeploymentFailed();
error Unauthorized();
error VaultAlreadyExists();
error ParentAlreadyExists();
error ChildAlreadyHasParent();
error ChildNotInParent();
error AssetMismatch();
/*//////////////////////////////////////////////////////////////
STRUCTS
//////////////////////////////////////////////////////////////*/
/**
* @notice Configuration for new vault deployment
* @param asset Asset address - USDC, WBTC, etc.
* @param poolId Market pair identifier - keccak256 of "BTC/USDC", "EUR/USDC", etc.
* @param name ERC20 name for vault shares (e.g., "Cartha BTC Vault")
* @param symbol ERC20 symbol for vault shares (e.g., "cvBTC")
* @dev All other parameters use global defaults set by admin:
* - maxLockDays: 365 days
* - minLockAmount: Asset-specific, set via vault after deployment
* - cooldownDuration: 7 days
* - epochDuration: 7 days (MUST be same for all vaults)
* - performancePenalty: 500 bps / 5% (MUST be same for all vaults)
*/
struct VaultConfig {
address asset;
bytes32 poolId;
string name;
string symbol;
}
/**
* @notice Vault metadata
* @param vaultAddress Deployed vault address
* @param asset Asset address
* @param deployedAt Block timestamp of deployment
* @param deployer Address that deployed the vault
*/
struct VaultInfo {
address vaultAddress;
address asset;
uint256 deployedAt;
address deployer;
}
/**
* @notice Configuration for parent vault deployment
* @param asset Asset address (USDC, etc.)
* @param category Category identifier - keccak256("metals"), keccak256("energy"), etc.
* @param name ERC20 name for parent vault shares (e.g., "Cartha Metals Vault")
* @param symbol ERC20 symbol for parent vault shares (e.g., "cvMETALS")
*/
struct ParentVaultConfig {
address asset;
bytes32 category;
string name;
string symbol;
}
/**
* @notice Parent vault metadata
* @param vaultAddress Deployed parent vault address
* @param asset Asset address
* @param category Category identifier
* @param deployedAt Block timestamp of deployment
* @param deployer Address that deployed the vault
*/
struct ParentVaultInfo {
address vaultAddress;
address asset;
bytes32 category;
uint256 deployedAt;
address deployer;
}
/*//////////////////////////////////////////////////////////////
DEPLOYMENT FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Deploy a new child vault for a specific asset and market pair
* @dev Only callable by addresses with FACTORY or ADMIN role in access control
* Vault is deployed with global default parameters
* Admin can update vault-specific parameters after deployment if needed
* @param config Vault configuration (asset + poolId)
* @return vault Address of deployed child vault
*/
function deployVault(VaultConfig calldata config) external returns (address vault);
/**
* @notice Deploy a new parent vault for a category
* @dev Only callable by addresses with FACTORY or ADMIN role
* Parent vault aggregates multiple child vaults by category
* @param config Parent vault configuration (asset + category + name + symbol)
* @return parentVault Address of deployed parent vault
*/
function deployParentVault(ParentVaultConfig calldata config) external returns (address parentVault);
/**
* @notice Add a child vault to a parent vault with weight allocation
* @dev Only callable by ADMIN role
* Child can only belong to one parent
* @param parent Parent vault address
* @param child Child vault address
* @param weight Weight for allocation (e.g., 40 for 40%)
* @param maxAllocation Maximum allocation in basis points (e.g., 5000 for 50%)
*/
function addChildToParent(address parent, address child, uint256 weight, uint256 maxAllocation) external;
/**
* @notice Remove a child vault from its parent
* @dev Only callable by ADMIN role
* @param parent Parent vault address
* @param child Child vault address
*/
function removeChildFromParent(address parent, address child) external;
/*//////////////////////////////////////////////////////////////
VIEW FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Get beacon address (all vaults reference this for implementation)
* @return beacon UpgradeableBeacon address
*/
function beacon() external view returns (address);
/**
* @notice Get access control (diamond proxy) address
* @return accessControl CarthaAccessControl address
*/
function accessControl() external view returns (address);
/**
* @notice Get total number of deployed vaults
* @return count Total vault count
*/
function getVaultCount() external view returns (uint256 count);
/**
* @notice Get vault info by ID
* @param vaultId Sequential vault ID (0-indexed)
* @return info Vault metadata
*/
function getVaultInfo(uint256 vaultId) external view returns (VaultInfo memory info);
/**
* @notice Get all deployed vaults
* @return vaults Array of vault addresses
*/
function getAllVaults() external view returns (address[] memory vaults);
/**
* @notice Get vaults for specific asset
* @param asset Asset address
* @return vaults Array of vault addresses
*/
function getVaultsByAsset(address asset) external view returns (address[] memory vaults);
/**
* @notice Check if address is a vault deployed by this factory
* @param vault Address to check
* @return isVault True if vault was deployed by this factory
*/
function isFactoryVault(address vault) external view returns (bool isVault);
/**
* @notice Get configuration from an existing vault
* @dev Extracts asset, poolId, name, and symbol from the vault using IERC20Metadata and ICarthaVault
* @param vault Vault address
* @return config VaultConfig with data from the vault
*/
function getDefaultConfig(address vault) external view returns (VaultConfig memory config);
/**
* @notice Get parent vault beacon address
* @return parentBeacon UpgradeableBeacon address for parent vaults
*/
function parentBeacon() external view returns (address);
/**
* @notice Get parent vault by category
* @param category Category identifier
* @return parent Parent vault address (zero address if not exists)
*/
function getParentByCategory(bytes32 category) external view returns (address parent);
/**
* @notice Get all child vaults of a parent
* @param parent Parent vault address
* @return children Array of child vault addresses
*/
function getChildrenOfParent(address parent) external view returns (address[] memory children);
/**
* @notice Get parent of a child vault
* @param child Child vault address
* @return parent Parent vault address (zero address if no parent)
*/
function getParentOfChild(address child) external view returns (address parent);
/**
* @notice Get all parent vaults
* @return parents Array of parent vault addresses
*/
function getAllParents() external view returns (address[] memory parents);
/**
* @notice Check if address is a parent vault deployed by this factory
* @param vault Address to check
* @return isParent True if parent vault was deployed by this factory
*/
function isParentVault(address vault) external view returns (bool isParent);
/**
* @notice Get total number of deployed parent vaults
* @return count Total parent vault count
*/
function getParentVaultCount() external view returns (uint256 count);
/**
* @notice Get parent vault info by ID
* @param vaultId Sequential parent vault ID (0-indexed)
* @return info Parent vault metadata
*/
function getParentVaultInfo(uint256 vaultId) external view returns (ParentVaultInfo memory info);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {Initializable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
import {UUPSUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol";
import {EIP712Upgradeable} from "openzeppelin-contracts-upgradeable/contracts/utils/cryptography/EIP712Upgradeable.sol";
import {ERC20Upgradeable} from "openzeppelin-contracts-upgradeable/contracts/token/ERC20/ERC20Upgradeable.sol";
import {ECDSA} from "openzeppelin-contracts/contracts/utils/cryptography/ECDSA.sol";
import {MerkleProof} from "openzeppelin-contracts/contracts/utils/cryptography/MerkleProof.sol";
import {PausableUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/utils/PausableUpgradeable.sol";
import {IERC20} from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {SafeERC20} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
import {ICarthaVault} from "./interfaces/ICarthaVault.sol";
import {ICarthaVaultEvents} from "./interfaces/ICarthaVaultEvents.sol";
import {ICarthaAccessControl} from "./interfaces/ICarthaAccessControl.sol";
import {Roles} from "./diamond/Roles.sol";
/**
* @title CarthaVault
* @notice Liquidity vault for Cartha subnet (SN35) with time-locked deposits
* @dev UUPS upgradeable, ERC20 shares with transfer locks, uses external AccessControl diamond
*/
contract CarthaVault is
ICarthaVault,
Initializable,
UUPSUpgradeable,
EIP712Upgradeable,
ERC20Upgradeable,
PausableUpgradeable
{
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////
CONSTANTS
//////////////////////////////////////////////////////////////*/
bytes32 public constant LOCK_REQUEST_TYPEHASH = keccak256(
"LockRequest(address owner,bytes32 poolId,uint256 amount,uint64 lockDays,bytes32 hotkey,uint256 timestamp,uint256 nonce)"
);
uint256 public constant SIGNATURE_VALIDITY_PERIOD = 5 minutes;
uint256 public constant EPOCH_DURATION = 7 days;
uint64 public constant MAX_LOCK_DAYS_LIMIT = 1825;
uint256 public constant MAX_PENALTY_BPS = 2000;
uint256 public constant DEFAULT_MINIMUM_LOCK_AMOUNT = 100_000e6; // 100k USDC (6 decimals)
/*//////////////////////////////////////////////////////////////
STORAGE
//////////////////////////////////////////////////////////////*/
/// @custom:storage-location erc7201:cartha.storage.CarthaVault
struct CarthaVaultStorage {
address accessControl;
address asset;
bytes32 poolId;
mapping(bytes32 => Position) positions;
mapping(address => uint256) depositNonces;
uint64 maxLockDays;
uint256 cooldownDuration;
uint256 performancePenalty;
bytes32 underperformerRoot;
bytes32 activeMinersRoot;
bytes32 evictionRoot;
uint256 totalPositions;
uint256 minimumLockAmount;
uint256 totalLockedAmount;
}
// keccak256(abi.encode(uint256(keccak256("cartha.storage.CarthaVault")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant CARTHA_VAULT_STORAGE_LOCATION =
0xe912e8bf36bf83660d227f6af14ede2c91a4dbb2e01a1a24b1d461b36bc30a00;
function _getCarthaVaultStorage() private pure returns (CarthaVaultStorage storage $) {
assembly {
$.slot := CARTHA_VAULT_STORAGE_LOCATION
}
}
/*//////////////////////////////////////////////////////////////
CONSTRUCTOR
//////////////////////////////////////////////////////////////*/
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
/*//////////////////////////////////////////////////////////////
INITIALIZER
//////////////////////////////////////////////////////////////*/
/**
* @notice Initialize the vault
* @param accessControl_ External access control diamond
* @param asset_ Asset token address (USDC, etc.)
* @param poolId_ Pool identifier
* @param name_ ERC20 token name
* @param symbol_ ERC20 token symbol
*/
function initialize(
address accessControl_,
address asset_,
bytes32 poolId_,
string memory name_,
string memory symbol_
) external initializer {
if (accessControl_ == address(0)) revert InvalidAccessControl();
if (asset_ == address(0)) revert InvalidAsset();
if (poolId_ == bytes32(0)) revert InvalidPoolId();
__EIP712_init("CarthaVault", "1");
__ERC20_init(name_, symbol_);
__Pausable_init();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.accessControl = accessControl_;
$.asset = asset_;
$.poolId = poolId_;
$.maxLockDays = 365;
$.cooldownDuration = 7 days;
$.performancePenalty = 500;
$.minimumLockAmount = DEFAULT_MINIMUM_LOCK_AMOUNT;
}
/*//////////////////////////////////////////////////////////////
MODIFIERS
//////////////////////////////////////////////////////////////*/
modifier onlyRole(uint8 role) {
_checkRole(role);
_;
}
function _checkRole(uint8 role) internal view {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (!ICarthaAccessControl($.accessControl).hasRole(role, msg.sender)) {
revert Unauthorized();
}
}
function _authorizeUpgrade(address newImplementation) internal override onlyRole(Roles.ADMIN) {}
/*//////////////////////////////////////////////////////////////
USER FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @inheritdoc ICarthaVault
*/
function lock(
bytes32 poolId_,
uint256 amount,
uint64 lockDays,
bytes32 hotkey,
uint256 timestamp,
bytes calldata signature
) external whenNotPaused {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (poolId_ != $.poolId) revert InvalidPoolId();
if (amount == 0) revert InvalidAmount();
if (amount < $.minimumLockAmount) revert InvalidAmount();
if (lockDays == 0 || lockDays > $.maxLockDays) revert InvalidLockDays();
bytes32 lockId = lockIdOf(msg.sender, poolId_);
if ($.positions[lockId].exists) revert PositionAlreadyExists();
_verifyLockSignature(
LockRequest({
owner: msg.sender,
poolId: poolId_,
amount: amount,
lockDays: lockDays,
hotkey: hotkey,
timestamp: timestamp,
nonce: $.depositNonces[msg.sender]
}),
signature
);
$.depositNonces[msg.sender]++;
if (block.timestamp > timestamp + SIGNATURE_VALIDITY_PERIOD) {
revert SignatureExpired();
}
IERC20($.asset).safeTransferFrom(msg.sender, address(this), amount);
_mint(msg.sender, _convertToShares(amount));
uint64 currentTime = uint64(block.timestamp);
$.positions[lockId] = Position({
amount: amount,
pendingAmount: 0,
lockDays: lockDays,
start: currentTime,
maxLockDays: lockDays,
// forge-lint: disable-next-line(unsafe-typecast)
lastEpoch: uint64(block.timestamp / EPOCH_DURATION),
cooldownEnds: currentTime + uint64($.cooldownDuration),
exists: true
});
$.totalPositions++;
$.totalLockedAmount += amount;
emit LockCreated(lockId, msg.sender, poolId_, address(this), amount, currentTime, lockDays);
}
/**
* @inheritdoc ICarthaVault
* @dev Top-ups go to pendingAmount and are regularized at epoch boundary
* No Merkle proof needed - position.exists ensures valid miner
* Underperformers will be force-exited (position deleted) before they can top up
*/
function lockTopUp(bytes32 poolId_, uint256 amount) external whenNotPaused {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (poolId_ != $.poolId) revert InvalidPoolId();
if (amount == 0) revert InvalidAmount();
bytes32 lockId = lockIdOf(msg.sender, poolId_);
Position storage position = $.positions[lockId];
if (!position.exists) revert PositionNotFound();
uint256 shares = _convertToShares(amount);
IERC20($.asset).safeTransferFrom(msg.sender, address(this), amount);
_mint(msg.sender, shares);
// Amount goes to pending, will be regularized at next epoch
position.pendingAmount += amount;
position.cooldownEnds = uint64(block.timestamp + $.cooldownDuration);
// forge-lint: disable-next-line(unsafe-typecast)
emit LockUpdated(lockId, int256(amount), position.lockDays);
}
/**
* @inheritdoc ICarthaVault
* @dev TODO: Consider batch size limits to avoid gas issues
*/
function regularizeBalances(address[] calldata owners) external onlyRole(Roles.KEEPER_BOT) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
for (uint256 i = 0; i < owners.length; i++) {
bytes32 lockId = lockIdOf(owners[i], $.poolId);
Position storage position = $.positions[lockId];
if (position.exists && position.pendingAmount > 0) {
uint256 pending = position.pendingAmount;
position.amount += pending;
position.pendingAmount = 0;
$.totalLockedAmount += pending;
// forge-lint: disable-next-line(unsafe-typecast)
emit LockUpdated(lockId, int256(pending), position.lockDays);
}
}
}
/**
* @inheritdoc ICarthaVault
*/
function release(bytes32 poolId_, uint256 amount) external whenNotPaused {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (poolId_ != $.poolId) revert InvalidPoolId();
bytes32 lockId = lockIdOf(msg.sender, poolId_);
Position storage position = $.positions[lockId];
if (!position.exists) revert PositionNotFound();
if (block.timestamp < position.start + uint256(position.lockDays) * 1 days) {
revert PositionLocked();
}
if (block.timestamp < position.cooldownEnds) revert CooldownNotExpired();
// Auto-regularize pending amount before release to prevent loss
if (position.pendingAmount > 0) {
uint256 pending = position.pendingAmount;
position.amount += pending;
position.pendingAmount = 0;
$.totalLockedAmount += pending;
}
if (amount == 0 || amount > position.amount) revert InvalidAmount();
uint256 shares = _convertToShares(amount);
bool isFullRelease = (amount == position.amount);
if (isFullRelease) {
delete $.positions[lockId];
$.totalPositions--;
} else {
position.amount -= amount;
}
$.totalLockedAmount -= amount;
_burn(msg.sender, shares);
IERC20($.asset).safeTransfer(msg.sender, amount);
if (isFullRelease) {
emit LockReleased(lockId, msg.sender, amount);
} else {
// forge-lint: disable-next-line(unsafe-typecast)
emit LockUpdated(lockId, -int256(amount), position.lockDays);
}
}
/**
* @inheritdoc ICarthaVault
*/
function extendLock(bytes32 poolId_, uint64 extensionDays) external whenNotPaused {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (poolId_ != $.poolId) revert InvalidPoolId();
bytes32 lockId = lockIdOf(msg.sender, poolId_);
Position storage position = $.positions[lockId];
if (!position.exists) revert PositionNotFound();
uint64 newLockDays = position.lockDays + extensionDays;
if (newLockDays <= position.lockDays) revert InvalidLockDays();
if (newLockDays > $.maxLockDays) revert InvalidLockDays();
position.lockDays = newLockDays;
if (newLockDays > position.maxLockDays) {
position.maxLockDays = newLockDays;
}
emit LockUpdated(lockId, 0, newLockDays);
}
/*//////////////////////////////////////////////////////////////
ADMIN FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @inheritdoc ICarthaVault
*/
function forceExit(address owner, bytes32 poolId_, bytes32[] calldata merkleProof)
external
onlyRole(Roles.EJECTOR)
{
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (poolId_ != $.poolId) revert InvalidPoolId();
bytes32 leaf;
assembly {
mstore(0x00, owner)
mstore(0x20, poolId_)
leaf := keccak256(0x00, 0x40)
}
if (!MerkleProof.verify(merkleProof, $.evictionRoot, leaf)) {
revert InvalidMerkleProof();
}
bytes32 lockId = lockIdOf(owner, poolId_);
Position storage position = $.positions[lockId];
if (!position.exists) revert PositionNotFound();
uint256 lockedAmount = position.amount;
uint256 totalAmount = lockedAmount + position.pendingAmount;
// Calculate shares and payout
uint256 shares;
uint256 payout;
{
uint256 expectedShares = _convertToShares(totalAmount);
uint256 actualShares = balanceOf(owner);
shares = actualShares < expectedShares ? actualShares : expectedShares;
payout = shares == expectedShares ? totalAmount : (totalAmount * shares) / expectedShares;
}
// forge-lint: disable-next-line(unsafe-typecast)
uint64 currentEpoch = uint64(block.timestamp / EPOCH_DURATION);
delete $.positions[lockId];
$.totalPositions--;
$.totalLockedAmount -= lockedAmount;
if (shares > 0) _burn(owner, shares);
if (payout > 0) IERC20($.asset).safeTransfer(owner, payout);
emit Evicted(lockId, owner, poolId_, payout, currentEpoch);
}
/**
* @inheritdoc ICarthaVault
*/
function forceExitUnderperformer(address owner, bytes32 poolId_, bytes32[] calldata merkleProof)
external
onlyRole(Roles.EJECTOR)
{
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (poolId_ != $.poolId) revert InvalidPoolId();
bytes32 leaf;
assembly {
mstore(0x00, owner)
mstore(0x20, poolId_)
leaf := keccak256(0x00, 0x40)
}
if (!MerkleProof.verify(merkleProof, $.underperformerRoot, leaf)) {
revert InvalidMerkleProof();
}
bytes32 lockId = lockIdOf(owner, poolId_);
Position storage position = $.positions[lockId];
if (!position.exists) revert PositionNotFound();
uint256 lockedAmount = position.amount;
uint256 totalAmount = lockedAmount + position.pendingAmount;
// Calculate shares and payout
uint256 shares;
uint256 payout;
{
uint256 expectedShares = _convertToShares(totalAmount);
uint256 actualShares = balanceOf(owner);
shares = actualShares < expectedShares ? actualShares : expectedShares;
payout = shares == expectedShares ? totalAmount : (totalAmount * shares) / expectedShares;
}
// Apply penalty
payout = payout - (payout * $.performancePenalty) / 10000;
delete $.positions[lockId];
$.totalPositions--;
$.totalLockedAmount -= lockedAmount;
if (shares > 0) _burn(owner, shares);
if (payout > 0) IERC20($.asset).safeTransfer(owner, payout);
// forge-lint: disable-next-line(unsafe-typecast)
emit Evicted(lockId, owner, poolId_, payout, uint64(block.timestamp / EPOCH_DURATION));
}
/**
* @inheritdoc ICarthaVault
*/
function emergencyPause() external onlyRole(Roles.ADMIN) {
_pause();
}
/**
* @inheritdoc ICarthaVault
*/
function unpause() external onlyRole(Roles.ADMIN) {
_unpause();
}
/**
* @inheritdoc ICarthaVault
*/
function rescueFunds(address token, address recipient, uint256 amount) external onlyRole(Roles.RESCUER) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
if (token == $.asset) revert CannotRescueVaultAsset();
if (recipient == address(0)) revert InvalidRecipient();
if (amount == 0) revert InvalidAmount();
IERC20(token).safeTransfer(recipient, amount);
emit FundsRescued(token, recipient, amount);
}
/*//////////////////////////////////////////////////////////////
CONFIGURATION FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @inheritdoc ICarthaVault
*/
function setMaxLockDays(uint64 newMax) external onlyRole(Roles.ADMIN) {
if (newMax == 0 || newMax > MAX_LOCK_DAYS_LIMIT) revert InvalidLockDays();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.maxLockDays = newMax;
}
/**
* @inheritdoc ICarthaVault
*/
function setCooldownDuration(uint256 newDuration) external onlyRole(Roles.ADMIN) {
if (newDuration > 30 days) revert InvalidCooldown();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.cooldownDuration = newDuration;
}
/**
* @inheritdoc ICarthaVault
*/
function setPerformancePenalty(uint256 newPenalty) external onlyRole(Roles.ADMIN) {
if (newPenalty > MAX_PENALTY_BPS) revert InvalidPenalty();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.performancePenalty = newPenalty;
}
/**
* @inheritdoc ICarthaVault
*/
function setMinimumLockAmount(uint256 newMinimum) external onlyRole(Roles.ADMIN) {
if (newMinimum == 0) revert InvalidAmount();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.minimumLockAmount = newMinimum;
}
/**
* @inheritdoc ICarthaVault
*/
function setUnderperformerRoot(bytes32 newRoot) external onlyRole(Roles.ADMIN) {
if (newRoot == bytes32(0)) revert InvalidRoot();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.underperformerRoot = newRoot;
}
/**
* @inheritdoc ICarthaVault
*/
function setActiveMinersRoot(bytes32 newRoot) external onlyRole(Roles.ADMIN) {
if (newRoot == bytes32(0)) revert InvalidRoot();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.activeMinersRoot = newRoot;
}
/**
* @notice Set eviction root for force exits
* @param newRoot New merkle root for eviction list
*/
function setEvictionRoot(bytes32 newRoot) external onlyRole(Roles.ADMIN) {
if (newRoot == bytes32(0)) revert InvalidRoot();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
$.evictionRoot = newRoot;
}
/**
* @inheritdoc ICarthaVault
*/
function depositFromParent(uint256 amount)
external
onlyRole(Roles.KEEPER_BOT)
whenNotPaused
returns (uint256 shares)
{
if (amount == 0) revert InvalidAmount();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
shares = _convertToShares(amount);
IERC20($.asset).safeTransferFrom(msg.sender, address(this), amount);
_mint(msg.sender, shares);
return shares;
}
/**
* @inheritdoc ICarthaVault
*/
function withdrawToParent(uint256 amount) external onlyRole(Roles.KEEPER_BOT) returns (uint256 assets) {
if (amount == 0) revert InvalidAmount();
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
// Convert requested assets to shares, rounding up to ensure we burn enough shares
uint256 totalShares = totalSupply();
uint256 totalAssets_ = _totalValueLocked();
uint256 shares;
if (totalAssets_ == 0 || totalShares == 0) {
shares = amount * 10 ** (decimals() - IERC20Metadata($.asset).decimals());
} else {
// Round up: (amount * totalShares + totalAssets_ - 1) / totalAssets_
shares = (amount * totalShares + totalAssets_ - 1) / totalAssets_;
}
if (balanceOf(msg.sender) < shares) revert InsufficientShares();
_burn(msg.sender, shares);
// Return actual amount available (handles rounding edge cases)
uint256 vaultBalance = IERC20($.asset).balanceOf(address(this));
assets = amount > vaultBalance ? vaultBalance : amount;
IERC20($.asset).safeTransfer(msg.sender, assets);
return assets;
}
/*//////////////////////////////////////////////////////////////
ERC20 OVERRIDE & HELPERS
//////////////////////////////////////////////////////////////*/
/**
* @dev Override to use 18 decimals for shares regardless of asset decimals
* @notice This provides better precision and follows ERC4626 best practices
*/
function decimals() public pure override returns (uint8) {
return 18;
}
/**
* @notice Override ERC20 transfer to enforce position locks
*/
function _update(address from, address to, uint256 value) internal override {
if (from != address(0)) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
bytes32 lockId = lockIdOf(from, $.poolId);
Position storage position = $.positions[lockId];
if (position.exists) {
bool locked = block.timestamp < position.start + uint256(position.lockDays) * 1 days;
if (locked) {
revert PositionLocked();
}
}
}
super._update(from, to, value);
}
/**
* @notice Convert assets to shares
* @dev Uses vault TVL and total shares for conversion with decimal offset
*/
function _convertToShares(uint256 assets) internal view returns (uint256 shares) {
uint256 totalShares = totalSupply();
uint256 totalAssets_ = _totalValueLocked();
if (totalShares == 0 || totalAssets_ == 0) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return assets * 10 ** (decimals() - IERC20Metadata($.asset).decimals());
}
return (assets * totalShares) / totalAssets_;
}
/**
* @notice Convert shares to assets
* @dev Uses vault TVL and total shares for conversion
*/
function _convertToAssets(uint256 shares) internal view returns (uint256 assets) {
uint256 totalShares = totalSupply();
if (totalShares == 0) return 0;
return (shares * _totalValueLocked()) / totalShares;
}
/**
* @notice Internal TVL calculation
*/
function _totalValueLocked() internal view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return IERC20($.asset).balanceOf(address(this));
}
/*//////////////////////////////////////////////////////////////
VIEW FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @inheritdoc ICarthaVault
* @dev One position per wallet per pool. For multiple miners, use different wallets.
*/
function lockIdOf(address owner, bytes32 poolId_) public pure returns (bytes32) {
bytes32 lockId;
assembly {
mstore(0x00, owner)
mstore(0x20, poolId_)
lockId := keccak256(0x00, 0x40)
}
return lockId;
}
/**
* @inheritdoc ICarthaVault
*/
function getPosition(address owner, bytes32 poolId_) external view returns (Position memory) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.positions[lockIdOf(owner, poolId_)];
}
/**
* @inheritdoc ICarthaVault
* @dev Returns array with single lockId if position exists, empty array otherwise
*/
function getUserLocks(address owner) external view returns (bytes32[] memory) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
bytes32 lockId = lockIdOf(owner, $.poolId);
if ($.positions[lockId].exists) {
bytes32[] memory locks = new bytes32[](1);
locks[0] = lockId;
return locks;
}
return new bytes32[](0);
}
/**
* @inheritdoc ICarthaVault
*/
function isLocked(address owner, bytes32 poolId_) external view returns (bool) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
Position storage position = $.positions[lockIdOf(owner, poolId_)];
if (!position.exists) return false;
return block.timestamp < position.start + uint256(position.lockDays) * 1 days;
}
/**
* @inheritdoc ICarthaVault
*/
function getCooldownRemaining(address owner, bytes32 poolId_) external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
Position storage position = $.positions[lockIdOf(owner, poolId_)];
if (!position.exists) return 0;
if (block.timestamp >= position.cooldownEnds) return 0;
return position.cooldownEnds - block.timestamp;
}
/**
* @inheritdoc ICarthaVault
*/
function canWithdraw(address owner, bytes32 poolId_) external view returns (bool) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
Position storage position = $.positions[lockIdOf(owner, poolId_)];
if (!position.exists) return false;
bool lockExpired = block.timestamp >= position.start + uint256(position.lockDays) * 1 days;
bool cooldownPassed = block.timestamp >= position.cooldownEnds;
return lockExpired && cooldownPassed;
}
/**
* @inheritdoc ICarthaVault
*/
function asset() external view returns (address) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.asset;
}
/**
* @inheritdoc ICarthaVault
*/
function poolId() external view returns (bytes32) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.poolId;
}
/**
* @inheritdoc ICarthaVault
*/
function maxLockDays() external view returns (uint64) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.maxLockDays;
}
/**
* @inheritdoc ICarthaVault
*/
function cooldownDuration() external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.cooldownDuration;
}
/**
* @inheritdoc ICarthaVault
*/
function epochDuration() external pure returns (uint256) {
return EPOCH_DURATION;
}
/**
* @inheritdoc ICarthaVault
*/
function performancePenalty() external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.performancePenalty;
}
/**
* @inheritdoc ICarthaVault
*/
function minimumLockAmount() external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.minimumLockAmount;
}
/**
* @inheritdoc ICarthaVault
*/
function underperformerRoot() external view returns (bytes32) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.underperformerRoot;
}
/**
* @inheritdoc ICarthaVault
*/
function activeMinersRoot() external view returns (bytes32) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.activeMinersRoot;
}
/**
* @inheritdoc ICarthaVault
*/
function totalValueLocked() external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return IERC20($.asset).balanceOf(address(this));
}
/**
* @inheritdoc ICarthaVault
*/
function totalPositions() external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.totalPositions;
}
/**
* @inheritdoc ICarthaVault
*/
function depositNonces(address owner) external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.depositNonces[owner];
}
/**
* @inheritdoc ICarthaVault
*/
function totalLockedAmount() external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
return $.totalLockedAmount;
}
/**
* @inheritdoc ICarthaVault
*/
function getUtilization() external view returns (uint256) {
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
uint256 tvl = IERC20($.asset).balanceOf(address(this));
if (tvl == 0) return 0;
return ($.totalLockedAmount * 10000) / tvl;
}
/**
* @inheritdoc ICarthaVault
*/
function positions(bytes32 lockId)
external
view
returns (
uint256 amount,
uint64 lockDays,
uint64 start,
uint64 maxLockDays_,
uint64 lastEpoch,
uint64 cooldownEnds,
bool exists
)
{
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
Position storage pos = $.positions[lockId];
return (pos.amount, pos.lockDays, pos.start, pos.maxLockDays, pos.lastEpoch, pos.cooldownEnds, pos.exists);
}
/// @inheritdoc ICarthaVault
function DOMAIN_SEPARATOR() external view returns (bytes32) {
return _domainSeparatorV4();
}
/// @inheritdoc ICarthaVault
function paused() public view override(PausableUpgradeable, ICarthaVault) returns (bool) {
return super.paused();
}
/*//////////////////////////////////////////////////////////////
INTERNAL FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Verify EIP-712 signature for lock request
* @param request LockRequest struct
* @param signature EIP-712 signature from verifier (EJECTOR role)
*/
function _verifyLockSignature(LockRequest memory request, bytes calldata signature) internal view {
bytes32 structHash;
bytes32 typehash = LOCK_REQUEST_TYPEHASH;
assembly {
let ptr := mload(0x40)
mstore(ptr, typehash)
mstore(add(ptr, 0x20), mload(request)) // owner
mstore(add(ptr, 0x40), mload(add(request, 0x20))) // poolId
mstore(add(ptr, 0x60), mload(add(request, 0x40))) // amount
mstore(add(ptr, 0x80), mload(add(request, 0x60))) // lockDays
mstore(add(ptr, 0xa0), mload(add(request, 0x80))) // hotkey
mstore(add(ptr, 0xc0), mload(add(request, 0xa0))) // timestamp
mstore(add(ptr, 0xe0), mload(add(request, 0xc0))) // nonce
structHash := keccak256(ptr, 0x100)
}
CarthaVaultStorage storage $ = _getCarthaVaultStorage();
bytes32 digest = _hashTypedDataV4(structHash);
address signer = ECDSA.recover(digest, signature);
if (!ICarthaAccessControl($.accessControl).hasRole(Roles.EJECTOR, signer)) {
revert Unauthorized();
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {Initializable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
import {UUPSUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol";
import {PausableUpgradeable} from "openzeppelin-contracts-upgradeable/contracts/utils/PausableUpgradeable.sol";
import {
ERC4626Upgradeable
} from "openzeppelin-contracts-upgradeable/contracts/token/ERC20/extensions/ERC4626Upgradeable.sol";
import {IERC20} from "openzeppelin-contracts/contracts/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {SafeERC20} from "openzeppelin-contracts/contracts/token/ERC20/utils/SafeERC20.sol";
import {ICarthaAccessControl} from "./interfaces/ICarthaAccessControl.sol";
import {ICarthaParentVault} from "./interfaces/ICarthaParentVault.sol";
import {ICarthaVault} from "./interfaces/ICarthaVault.sol";
import {Roles} from "./diamond/Roles.sol";
/**
* @title CarthaParentVault
* @notice ERC4626-compliant parent vault managing liquidity across multiple CarthaVault child pools
*/
contract CarthaParentVault is
Initializable,
UUPSUpgradeable,
PausableUpgradeable,
ERC4626Upgradeable,
ICarthaParentVault
{
using SafeERC20 for IERC20;
/// @custom:storage-location erc7201:cartha.storage.ParentVault
struct ParentVaultStorage {
bytes32 category;
ICarthaAccessControl diamond;
address[] vaultList;
mapping(address => PoolConfig) pools;
mapping(address => uint256) vaultIndex;
mapping(address => Position) positions;
RebalanceConfig rebalanceConfig;
uint256 lastRebalanceTime;
}
// keccak256(abi.encode(uint256(keccak256("cartha.storage.ParentVault")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant PARENT_VAULT_STORAGE_LOCATION =
0x132a1344191806d6acd57512ba0c4193d7f59e510e17f64a6c527c52607be700;
function _getParentVaultStorage() private pure returns (ParentVaultStorage storage $) {
assembly {
$.slot := PARENT_VAULT_STORAGE_LOCATION
}
}
uint256 private constant BASIS_POINTS = 10000;
uint256 private constant SHARE_DECIMALS = 18;
modifier onlyRole(uint8 role) {
ParentVaultStorage storage $ = _getParentVaultStorage();
if (!$.diamond.hasRole(role, msg.sender)) {
revert Unauthorized();
}
_;
}
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
function initialize(address asset_, bytes32 category_, string memory name_, string memory symbol_, address diamond_)
external
initializer
{
__ERC20_init(name_, symbol_);
__ERC4626_init(IERC20(asset_));
__Pausable_init();
ParentVaultStorage storage $ = _getParentVaultStorage();
$.category = category_;
$.diamond = ICarthaAccessControl(diamond_);
$.rebalanceConfig =
RebalanceConfig({minRebalanceInterval: 1 days, utilizationThreshold: 8000, maxShiftPerRebalance: 2000});
}
/*//////////////////////////////////////////////////////////////
ERC4626 OVERRIDES
//////////////////////////////////////////////////////////////*/
/**
* @dev Override to use 18 decimals for shares regardless of asset decimals
* @notice This provides better precision and follows ERC4626 best practices
*/
function decimals() public pure override(ERC4626Upgradeable, IERC20Metadata) returns (uint8) {
return 18;
}
/**
* @dev Override decimals offset for inflation attack protection
* @notice Returns 12 to match decimal difference (18 - 6) and protect against donation attacks
*/
function _decimalsOffset() internal pure override returns (uint8) {
return 12;
}
/**
* @dev Override ERC4626 deposit hook to distribute assets to child vaults
*/
function _deposit(address caller, address receiver, uint256 assets, uint256 shares)
internal
override
whenNotPaused
{
ParentVaultStorage storage $ = _getParentVaultStorage();
// Transfer assets from caller
SafeERC20.safeTransferFrom(IERC20(asset()), caller, address(this), assets);
// Mint shares to receiver
_mint(receiver, shares);
// Track position
$.positions[receiver].shares += shares;
if ($.positions[receiver].depositedAt == 0) {
$.positions[receiver].depositedAt = block.timestamp;
}
// Distribute to children
_distributeToChildren(assets);
emit Deposit(caller, receiver, assets, shares);
}
/**
* @dev Override ERC4626 withdraw hook to pull assets from child vaults
*/
function _withdraw(address caller, address receiver, address owner, uint256 assets, uint256 shares)
internal
override
whenNotPaused
{
ParentVaultStorage storage $ = _getParentVaultStorage();
// Handle allowance if caller is not owner
if (caller != owner) {
_spendAllowance(owner, caller, shares);
}
// Burn shares
_burn(owner, shares);
$.positions[owner].shares -= shares;
// Withdraw from children
_withdrawFromChildren(assets);
// Use actual balance to handle rounding (may be 1-2 wei less than calculated)
uint256 actualAmount = IERC20(asset()).balanceOf(address(this));
if (actualAmount > assets) actualAmount = assets;
// Transfer assets to receiver
SafeERC20.safeTransfer(IERC20(asset()), receiver, actualAmount);
emit Withdraw(caller, receiver, owner, actualAmount, shares);
}
/**
* @inheritdoc ICarthaParentVault
*/
function shiftLiquidity(address fromVault, address toVault, uint256 amount)
external
override
onlyRole(Roles.KEEPER_BOT)
whenNotPaused
{
ParentVaultStorage storage $ = _getParentVaultStorage();
if (!$.pools[fromVault].isActive || !$.pools[toVault].isActive) {
revert PoolNotActive();
}
if (ICarthaVault(toVault).paused()) revert PoolNotActive();
if (amount == 0) revert InvalidAmount();
uint256 withdrawn = ICarthaVault(fromVault).withdrawToParent(amount);
IERC20(asset()).forceApprove(toVault, withdrawn);
ICarthaVault(toVault).depositFromParent(withdrawn);
IERC20(asset()).forceApprove(toVault, 0);
emit LiquidityShifted(fromVault, toVault, withdrawn);
}
/**
* @inheritdoc ICarthaParentVault
*/
function addPool(address vault, uint256 weight, uint256 maxAllocation) external override onlyRole(Roles.ADMIN) {
ParentVaultStorage storage $ = _getParentVaultStorage();
if (vault == address(0)) revert InvalidVault();
if ($.pools[vault].vault != address(0)) revert PoolAlreadyExists();
if (maxAllocation > BASIS_POINTS) revert InvalidAllocation();
$.vaultList.push(vault);
$.vaultIndex[vault] = $.vaultList.length - 1;
$.pools[vault] = PoolConfig({
vault: vault, weight: weight, targetWeight: weight, maxAllocation: maxAllocation, isActive: true
});
emit PoolAdded(vault, weight, maxAllocation);
}
/**
* @inheritdoc ICarthaParentVault
*/
function removePool(address vault, bool shouldRebalance) external override onlyRole(Roles.ADMIN) {
ParentVaultStorage storage $ = _getParentVaultStorage();
if ($.pools[vault].vault == address(0)) revert PoolNotFound();
uint256 parentShares = IERC20(vault).balanceOf(address(this));
uint256 totalShares = IERC20(vault).totalSupply();
uint256 vaultTVL = ICarthaVault(vault).totalValueLocked();
if (totalShares > 0 && parentShares > 0) {
uint256 withdrawAmount = (parentShares * vaultTVL) / totalShares;
if (withdrawAmount > 0) {
ICarthaVault(vault).withdrawToParent(withdrawAmount);
}
}
uint256 index = $.vaultIndex[vault];
uint256 lastIndex = $.vaultList.length - 1;
if (index != lastIndex) {
address lastVault = $.vaultList[lastIndex];
$.vaultList[index] = lastVault;
$.vaultIndex[lastVault] = index;
}
$.vaultList.pop();
delete $.vaultIndex[vault];
delete $.pools[vault];
emit PoolRemoved(vault);
if (shouldRebalance) {
_rebalanceToWeights();
}
}
/**
* @notice Internal function to rebalance all pools to their target weights
* @return totalShifted Total amount of assets moved between pools
*/
function _rebalanceToWeights() internal returns (uint256 totalShifted) {
ParentVaultStorage storage $ = _getParentVaultStorage();
uint256 totalAssets_ = totalAssets();
if (totalAssets_ == 0) return 0;
// Calculate total weight
uint256 totalWeight;
for (uint256 i = 0; i < $.vaultList.length; i++) {
address vault = $.vaultList[i];
if ($.pools[vault].isActive && !ICarthaVault(vault).paused()) {
totalWeight += $.pools[vault].weight;
}
}
if (totalWeight == 0) return 0;
// Rebalance each vault to its target allocation
for (uint256 i = 0; i < $.vaultList.length; i++) {
address vault = $.vaultList[i];
if (!$.pools[vault].isActive || ICarthaVault(vault).paused()) continue;
uint256 targetAllocation = (totalAssets_ * $.pools[vault].weight) / totalWeight;
// Calculate parent's current allocation based on shares held
uint256 parentShares = IERC20(vault).balanceOf(address(this));
uint256 childTotalSupply = IERC20(vault).totalSupply();
uint256 childTVL = ICarthaVault(vault).totalValueLocked();
uint256 currentAllocation =
(childTotalSupply > 0 && parentShares > 0) ? (parentShares * childTVL) / childTotalSupply : 0;
if (targetAllocation > currentAllocation) {
// Need to deposit more
uint256 depositAmount = targetAllocation - currentAllocation;
uint256 available = IERC20(asset()).balanceOf(address(this));
if (depositAmount > available) depositAmount = available;
if (depositAmount > 0) {
IERC20(asset()).forceApprove(vault, depositAmount);
ICarthaVault(vault).depositFromParent(depositAmount);
IERC20(asset()).forceApprove(vault, 0);
totalShifted += depositAmount;
}
} else if (targetAllocation < currentAllocation) {
// Need to withdraw
uint256 withdrawAmount = currentAllocation - targetAllocation;
if (withdrawAmount > 0) {
ICarthaVault(vault).withdrawToParent(withdrawAmount);
totalShifted += withdrawAmount;
}
}
}
}
/**
* @inheritdoc ICarthaParentVault
*/
function updatePoolWeight(address vault, uint256 newWeight) external override onlyRole(Roles.ADMIN) {
ParentVaultStorage storage $ = _getParentVaultStorage();
if ($.pools[vault].vault == address(0)) revert PoolNotFound();
uint256 oldWeight = $.pools[vault].weight;
$.pools[vault].weight = newWeight;
emit PoolWeightUpdated(vault, oldWeight, newWeight);
}
/**
* @inheritdoc ICarthaParentVault
*/
function setRebalanceConfig(RebalanceConfig calldata config) external override onlyRole(Roles.ADMIN) {
ParentVaultStorage storage $ = _getParentVaultStorage();
$.rebalanceConfig = config;
}
/**
* @inheritdoc ICarthaParentVault
*/
function rebalance() external override onlyRole(Roles.KEEPER_BOT) returns (uint256 totalShifted) {
ParentVaultStorage storage $ = _getParentVaultStorage();
if (block.timestamp < $.lastRebalanceTime + $.rebalanceConfig.minRebalanceInterval) {
revert RebalanceTooSoon();
}
totalShifted = _rebalanceToWeights();
$.lastRebalanceTime = block.timestamp;
emit Rebalanced(block.timestamp, totalShifted);
}
/**
* @inheritdoc ICarthaParentVault
*/
function calculateTargetAllocations()
public
view
override
returns (address[] memory vaults, uint256[] memory targetWeights)
{
ParentVaultStorage storage $ = _getParentVaultStorage();
uint256 poolCount = $.vaultList.length;
vaults = new address[](poolCount);
targetWeights = new uint256[](poolCount);
uint256 totalWeight;
for (uint256 i = 0; i < poolCount; i++) {
vaults[i] = $.vaultList[i];
targetWeights[i] = $.pools[$.vaultList[i]].weight;
totalWeight += targetWeights[i];
}
if (totalWeight > 0) {
for (uint256 i = 0; i < poolCount; i++) {
targetWeights[i] = (targetWeights[i] * BASIS_POINTS) / totalWeight;
}
}
}
/**
* @inheritdoc ICarthaParentVault
*/
function sharePrice() public view override returns (uint256) {
uint256 totalShares = totalSupply();
if (totalShares == 0) return 10 ** IERC20Metadata(asset()).decimals();
return (totalAssets() * 10 ** SHARE_DECIMALS) / totalShares;
}
/**
* @inheritdoc ERC4626Upgradeable
* @dev Calculates parent's share of assets in child vaults based on shares held
* This ensures miner locks don't dilute LP share calculations
*/
function totalAssets() public view override(ERC4626Upgradeable, ICarthaParentVault) returns (uint256 total) {
ParentVaultStorage storage $ = _getParentVaultStorage();
for (uint256 i = 0; i < $.vaultList.length; i++) {
address vault = $.vaultList[i];
if ($.pools[vault].isActive) {
// Calculate parent's portion based on shares held in child vault
uint256 parentShares = IERC20(vault).balanceOf(address(this));
uint256 childTotalSupply = IERC20(vault).totalSupply();
uint256 childTVL = ICarthaVault(vault).totalValueLocked();
if (childTotalSupply > 0 && parentShares > 0) {
total += (parentShares * childTVL) / childTotalSupply;
}
}
}
total += IERC20(asset()).balanceOf(address(this));
}
/**
* @inheritdoc ICarthaParentVault
*/
function getPools() external view override returns (PoolConfig[] memory configs) {
ParentVaultStorage storage $ = _getParentVaultStorage();
uint256 poolCount = $.vaultList.length;
configs = new PoolConfig[](poolCount);
for (uint256 i = 0; i < poolCount; i++) {
configs[i] = $.pools[$.vaultList[i]];
}
}
/**
* @inheritdoc ICarthaParentVault
*/
function getPoolUtilization(address vault) public view override returns (uint256 utilization) {
ParentVaultStorage storage $ = _getParentVaultStorage();
if ($.pools[vault].vault == address(0)) revert PoolNotFound();
return ICarthaVault(vault).getUtilization();
}
/**
* @inheritdoc ICarthaParentVault
*/
function getPosition(address user) external view override returns (Position memory position) {
ParentVaultStorage storage $ = _getParentVaultStorage();
return $.positions[user];
}
/**
* @inheritdoc ICarthaParentVault
*/
function category() external view override returns (bytes32) {
ParentVaultStorage storage $ = _getParentVaultStorage();
return $.category;
}
/**
* @notice Distribute deposited USDC to child pools by weight
*/
function _distributeToChildren(uint256 amount) internal {
ParentVaultStorage storage $ = _getParentVaultStorage();
uint256 totalWeight;
for (uint256 i = 0; i < $.vaultList.length; i++) {
address vault = $.vaultList[i];
if ($.pools[vault].isActive && !ICarthaVault(vault).paused()) {
totalWeight += $.pools[vault].weight;
}
}
if (totalWeight == 0) revert NoActivePools();
for (uint256 i = 0; i < $.vaultList.length; i++) {
address vault = $.vaultList[i];
if (!$.pools[vault].isActive || ICarthaVault(vault).paused()) continue;
uint256 allocation = (amount * $.pools[vault].weight) / totalWeight;
if (allocation > 0) {
IERC20(asset()).forceApprove(vault, allocation);
ICarthaVault(vault).depositFromParent(allocation);
IERC20(asset()).forceApprove(vault, 0);
}
}
}
/**
* @notice Withdraw USDC from child pools proportionally
*/
function _withdrawFromChildren(uint256 amount) internal {
ParentVaultStorage storage $ = _getParentVaultStorage();
uint256 remaining = amount;
uint256 totalAssets_ = totalAssets();
for (uint256 i = 0; i < $.vaultList.length && remaining > 0; i++) {
address vault = $.vaultList[i];
if (!$.pools[vault].isActive) continue;
// Calculate parent's share of this vault
uint256 parentShares = IERC20(vault).balanceOf(address(this));
uint256 childTotalSupply = IERC20(vault).totalSupply();
uint256 childTVL = ICarthaVault(vault).totalValueLocked();
if (childTotalSupply == 0 || parentShares == 0) continue;
uint256 parentShareValue = (parentShares * childTVL) / childTotalSupply;
uint256 withdrawAmount = (amount * parentShareValue) / totalAssets_;
if (withdrawAmount > remaining) withdrawAmount = remaining;
if (withdrawAmount > parentShareValue) withdrawAmount = parentShareValue;
if (withdrawAmount == 0) continue;
uint256 withdrawn = ICarthaVault(vault).withdrawToParent(withdrawAmount);
remaining -= withdrawn;
}
}
/*//////////////////////////////////////////////////////////////
ADMIN FUNCTIONS
//////////////////////////////////////////////////////////////*/
function emergencyPause() external onlyRole(Roles.ADMIN) {
_pause();
}
function unpause() external onlyRole(Roles.ADMIN) {
_unpause();
}
function _authorizeUpgrade(address newImplementation) internal override onlyRole(Roles.ADMIN) {}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {IERC4626} from "@openzeppelin/contracts/interfaces/IERC4626.sol";
import {ICarthaParentVaultErrors} from "./ICarthaParentVaultErrors.sol";
/**
* @title ICarthaParentVault
* @notice ERC4626-compliant interface for Cartha parent vault managing multiple child pool vaults
*
* Parent manages liquidity allocation across multiple CarthaVault instances
* Implements auto-rebalancing based on utilization, volume, and governance votes
* Fully ERC4626-compliant for DeFi ecosystem compatibility
*/
interface ICarthaParentVault is IERC4626, ICarthaParentVaultErrors {
/*//////////////////////////////////////////////////////////////
STRUCTS
//////////////////////////////////////////////////////////////*/
/**
* @notice Configuration for a child pool vault
* @param vault Address of the CarthaVault (child pool) contract
* @param weight Current allocation weight (basis points, 0-10000)
* @param targetWeight Target weight from rebalancing algorithm
* @param maxAllocation Maximum % of parent TVL this pool can hold (basis points)
* @param isActive Whether pool is currently accepting deposits
*/
struct PoolConfig {
address vault;
uint256 weight;
uint256 targetWeight;
uint256 maxAllocation;
bool isActive;
}
/**
* @notice LP position in the parent vault
* @param shares Amount of parent vault tokens owned
* @param depositedAt Timestamp of initial deposit
*/
struct Position {
uint256 shares;
uint256 depositedAt;
}
/**
* @notice Rebalancing parameters
* @param minRebalanceInterval Minimum seconds between rebalances
* @param utilizationThreshold Utilization % that triggers rebalance (basis points)
* @param maxShiftPerRebalance Max % of pool that can be moved in one rebalance (basis points)
*/
struct RebalanceConfig {
uint256 minRebalanceInterval;
uint256 utilizationThreshold;
uint256 maxShiftPerRebalance;
}
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/
event Deposit(address indexed user, uint256 amount, uint256 shares, uint256 sharePrice);
event Withdraw(address indexed user, uint256 shares, uint256 amount, uint256 sharePrice);
event PoolAdded(address indexed vault, uint256 weight, uint256 maxAllocation);
event PoolRemoved(address indexed vault);
event PoolWeightUpdated(address indexed vault, uint256 oldWeight, uint256 newWeight);
event Rebalanced(uint256 timestamp, uint256 totalMoved);
event LiquidityShifted(address indexed fromVault, address indexed toVault, uint256 amount);
/*//////////////////////////////////////////////////////////////
LIQUIDITY FUNCTIONS
//////////////////////////////////////////////////////////////*/
// deposit() and withdraw() are provided by IERC4626
// Standard ERC4626 signatures:
// - function deposit(uint256 assets, address receiver) external returns (uint256 shares);
// - function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
/**
* @notice Shift liquidity between pools without fees
* @dev Only callable by ADMIN or KEEPER_BOT
* Price impact still applies based on pool balance
* @param fromVault Source child pool
* @param toVault Destination child pool
* @param amount USDC amount to shift
*/
function shiftLiquidity(address fromVault, address toVault, uint256 amount) external;
/*//////////////////////////////////////////////////////////////
POOL MANAGEMENT
//////////////////////////////////////////////////////////////*/
/**
* @notice Add new child pool to parent vault
* @dev Only callable by ADMIN
* @param vault CarthaVault address
* @param weight Initial allocation weight (basis points)
* @param maxAllocation Max % of parent TVL (basis points, e.g., 4000 = 40%)
*/
function addPool(address vault, uint256 weight, uint256 maxAllocation) external;
/**
* @notice Remove child pool from parent vault
* @dev Only callable by ADMIN. Must withdraw all liquidity first.
* @param vault CarthaVault address
* @param rebalance If true, rebalance remaining pools to their target weights
*/
function removePool(address vault, bool rebalance) external;
/**
* @notice Update pool weight (for governance/veAlpha votes)
* @dev Only callable by ADMIN
* @param vault CarthaVault address
* @param newWeight New allocation weight (basis points)
*/
function updatePoolWeight(address vault, uint256 newWeight) external;
/**
* @notice Set rebalancing configuration
* @dev Only callable by ADMIN
* @param config Rebalancing parameters
*/
function setRebalanceConfig(RebalanceConfig calldata config) external;
/*//////////////////////////////////////////////////////////////
REBALANCING
//////////////////////////////////////////////////////////////*/
/**
* @notice Execute rebalancing across all pools
* @dev Callable by KEEPER_BOT or ADMIN
* Shifts funds from low-utilization → high-utilization pools
* Based on: utilization rate, trading volume, LP concentration
* @return totalShifted Total USDC moved between pools
*/
function rebalance() external returns (uint256 totalShifted);
/**
* @notice Calculate optimal allocation for each pool
* @dev Public view for transparency
* Factors: utilization, volume, concentration, veAlpha votes
* @return vaults Array of pool addresses
* @return targetWeights Array of target weights (basis points)
*/
function calculateTargetAllocations()
external
view
returns (address[] memory vaults, uint256[] memory targetWeights);
/*//////////////////////////////////////////////////////////////
VIEWS
//////////////////////////////////////////////////////////////*/
/**
* @notice Get current parent vault share price
* @dev price = (totalAssets + netPnL) / totalShares
* @return price Share price in USDC (scaled to asset decimals)
*/
function sharePrice() external view returns (uint256 price);
/**
* @notice Get total assets under management
* @dev Sum of all USDC across child pools
* @return total Total USDC in parent vault
*/
function totalAssets() external view returns (uint256 total);
/**
* @notice Get all child pools and their configs
* @return configs Array of pool configurations
*/
function getPools() external view returns (PoolConfig[] memory configs);
/**
* @notice Get pool utilization rate
* @dev utilization = reservedLiquidity / totalLiquidity
* @param vault Child pool address
* @return utilization Utilization rate (basis points, 0-10000)
*/
function getPoolUtilization(address vault) external view returns (uint256 utilization);
/**
* @notice Get LP's position in parent vault
* @param user LP address
* @return position Position details
*/
function getPosition(address user) external view returns (Position memory position);
// The following ERC4626 standard functions are inherited:
// - previewDeposit(assets) -> shares
// - previewMint(shares) -> assets
// - previewWithdraw(assets) -> shares
// - previewRedeem(shares) -> assets
// - asset() -> address
/**
* @notice Get parent vault category (CCY, Crypto, Commodities)
* @return category Vault category identifier
*/
function category() external view returns (bytes32 category);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title ICarthaAccessControl
* @notice Centralized role-based access control for all Cartha vaultson
*/
interface ICarthaAccessControl {
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/
/**
* @notice Emitted when a role is granted to an account
* @param role Role identifier uint8
* @param account Address receiving the role
* @param sender Address that granted the role
*/
event RoleGranted(uint8 indexed role, address indexed account, address indexed sender);
/**
* @notice Emitted when a role is revoked from an account
* @param role Role identifier uint8
* @param account Address losing the role
* @param sender Address that revoked the role
*/
event RoleRevoked(uint8 indexed role, address indexed account, address indexed sender);
/*//////////////////////////////////////////////////////////////
ERRORS
//////////////////////////////////////////////////////////////*/
error Unauthorized();
error InvalidRole();
error InvalidAccount();
/*//////////////////////////////////////////////////////////////
ROLE MANAGEMENT FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Grant a global role to an account
* @dev Only callable by ADMIN role
* @param role Role to grant, see Roles.sol
* @param account Address to grant role to
*/
function grantRole(uint8 role, address account) external;
/**
* @notice Revoke a global role from an account
* @dev Only callable by ADMIN role
* @param role Role to revoke
* @param account Address to revoke role from
*/
function revokeRole(uint8 role, address account) external;
/**
* @notice Renounce a role, self-revoke
* @param role Role to renounce
*/
function renounceRole(uint8 role) external;
/*//////////////////////////////////////////////////////////////
VIEW FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Check if an account has a global role
* @param role Role to check
* @param account Address to check
* @return True if account has role
*/
function hasRole(uint8 role, address account) external view returns (bool);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {ICarthaVaultEvents} from "./ICarthaVaultEvents.sol";
import {ICarthaVaultErrors} from "./ICarthaVaultErrors.sol";
/**
* @title ICarthaVault
* @notice Interface for Cartha liquidity vault with Bittensor subnet integration
* @dev Per-market USDC vault with time-locked deposits and epoch-based accounting
*
* Architecture:
* - One position per (owner, poolId): lockId = keccak256(owner, poolId)
* - Registration enforcement via verifier signatures (off-chain approval)
* - Event-sourced for validator replay and scoring
* - Weekly epochs
* - Cooldown after deposits/top-ups
*
* Integration:
* - Miners register on Bittensor subnet (SN35)
* - Verifier signs deposit approval (off-chain)
* - Miners deposit USDC with signature
* - Validators replay events to calculate scores
* - Scores → Bittensor weights → TAO + Alpha emissions
*/
interface ICarthaVault is ICarthaVaultEvents, ICarthaVaultErrors {
/*//////////////////////////////////////////////////////////////
STRUCTS
//////////////////////////////////////////////////////////////*/
/**
* @notice Position data structure
* @param amount USDC locked
* @param lockDays Current lock duration in days
* @param start Block timestamp when position was created
* @param maxLockDays Maximum lock duration at creation
* @param lastEpoch Last epoch when position was active (timestamp / epochDuration)
* @param cooldownEnds Timestamp when withdrawal cooldown expires (start + cooldownDuration)
* @param exists Flag to differentiate from uninitialized positions
*/
struct Position {
uint256 amount; // Locked amount (earning rewards)
uint256 pendingAmount; // Pending top-up (locked into next epoch)
uint64 lockDays;
uint64 start;
uint64 maxLockDays;
uint64 lastEpoch;
uint64 cooldownEnds;
bool exists;
}
/**
* @notice EIP-712 typed data for initial lock registration
* @dev Used for first-time deposits with full verifier validation
* @param owner Miner's EVM address
* @param poolId Market identifier
* @param amount USDC amount to lock
* @param lockDays Lock duration in days
* @param hotkey Bittensor hotkey for subnet registration
* @param timestamp Unix timestamp when request was created
* @param nonce Replay attack prevention (increments per user)
*/
struct LockRequest {
address owner;
bytes32 poolId;
uint256 amount;
uint64 lockDays;
bytes32 hotkey;
uint256 timestamp;
uint256 nonce;
}
/*//////////////////////////////////////////////////////////////
USER FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Create new position with initial deposit (first-time registration)
* @dev Requires valid EIP-712 signature from verifier (ensures Bittensor registration)
*
* Flow:
* 1. Miner registers on Bittensor subnet and gets hotkey
* 2. Miner requests lock approval from verifier with hotkey
* 3. Verifier signs EIP-712 typed data
* 4. Miner calls this function with signature
* 5. Contract validates signature and creates position
* 6. Position locks into NEXT epoch (not current)
*
* @param poolId Market identifier (e.g., keccak256("EUR/USD"))
* @param amount AssetAmount (USDC, etc) amount to deposit (must be >= minLockAmount)
* @param lockDays Lock duration in days (must be > 0 and <= maxLockDays)
* @param hotkey Bittensor hotkey for subnet registration
* @param timestamp Request timestamp
* @param signature EIP-712 signature from verifierSigner
*/
function lock(
bytes32 poolId,
uint256 amount,
uint64 lockDays,
bytes32 hotkey,
uint256 timestamp,
bytes calldata signature
) external;
/**
* @notice Top-up existing position with additional funds
* Flow:
* 1. User calls this function (must have existing position)
* 2. Amount added to pendingAmount (not earning rewards yet)
* 3. Bot calls regularizeBalances() at epoch boundary
* 4. Pending moves to locked amount (starts earning rewards next epoch)
*
* @param poolId Market identifier
* @param amount Asset (USDC, etc) amount to add (6 decimals, must be > 0)
*/
function lockTopUp(bytes32 poolId, uint256 amount) external;
/**
* @notice Regularize pending balances at epoch boundary
* @dev Called by keeper bot at start of each epoch
* Moves pendingAmount to amount for all positions with pending funds
* Uses vault's own poolId (each vault is specific to one pool)
*
* TODO: Define batch size limits to avoid gas issues
*
* @param owners Array of position owners to regularize
*/
function regularizeBalances(address[] calldata owners) external;
/**
* @notice Withdraw unlocked funds
* @dev Requirements:
* - Position must exist
* - Lock period must be expired (block.timestamp >= start + lockDays * 1 days)
* - Cooldown must be passed (block.timestamp >= cooldownEnds)
* - amount <= position.amount
*
* @param poolId Market identifier
* @param amount Amount to withdraw (full release if amount == position.amount)
*/
function release(bytes32 poolId, uint256 amount) external;
/**
* @notice Extend lock duration without adding funds
* @dev Useful for miners wanting to increase their lock boost without depositing more
*
* @param poolId Market identifier
* @param newLockDays New lock duration (must be > current and <= maxLockDays)
*/
function extendLock(bytes32 poolId, uint64 newLockDays) external;
/*//////////////////////////////////////////////////////////////
ADMIN FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Force exit deregistered miner (no penalty)
* @dev Called by keeper bot when miner loses active set slot on Bittensor
* - Returns full amount to owner
* - Requires valid merkle proof against evictionRoot
* - Only callable by EJECTOR_ROLE
*
* Flow:
* 1. Epoch roll occurs (validators compute next active set)
* 2. Verifier builds eviction list for deregistered miners
* 3. Verifier publishes evictionRoot on-chain (via ADMIN)
* 4. Keeper bot calls forceExit with Merkle proof for each eviction
* 5. On-chain verification prevents unauthorized exits
*
* @param owner Miner's EVM address
* @param poolId Market identifier
* @param merkleProof Proof that (owner, poolId) is in eviction list
*/
function forceExit(address owner, bytes32 poolId, bytes32[] calldata merkleProof) external;
/**
* @notice Force exit underperforming miner with penalty
* @dev Called by verifier for miners below performance threshold
* - Applies performancePenalty % (default 5%)
* - Penalty stays in vault as protocol revenue
* - Requires valid merkle proof against underperformerRoot
* - Only callable by EJECTOR_ROLE
*
* @param owner Miner's EVM address
* @param poolId Market identifier
* @param merkleProof Proof that (owner, poolId) is in underperformer list
*/
function forceExitUnderperformer(address owner, bytes32 poolId, bytes32[] calldata merkleProof) external;
/**
* @notice Emergency pause all operations (lock, release, extendLock)
* @dev Only callable by PAUSER_ROLE
*/
function emergencyPause() external;
/**
* @notice Unpause contract
* @dev Only callable by DEFAULT_ADMIN_ROLE
*/
function unpause() external;
/**
* @notice Rescue stuck or lost funds from vault
* @dev Only callable by RESCUER role
*
* @param token Token address to rescue
* @param recipient Address to receive funds
* @param amount Amount to rescue
*/
function rescueFunds(address token, address recipient, uint256 amount) external;
/*//////////////////////////////////////////////////////////////
CONFIGURATION FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Set maximum lock duration
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @param newMax New maximum (must be > 0 and <= 1825 days / 5 years)
*/
function setMaxLockDays(uint64 newMax) external;
/**
* @notice Set cooldown duration after deposits
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @param newDuration New duration in seconds (must be <= 30 days)
*/
function setCooldownDuration(uint256 newDuration) external;
/**
* @notice Set penalty for underperformers
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @param newPenalty New penalty in basis points (max 2000 = 20%)
*/
function setPerformancePenalty(uint256 newPenalty) external;
/**
* @notice Set minimum lock amount
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @param newMinimum New minimum lock amount (must be > 0)
*/
function setMinimumLockAmount(uint256 newMinimum) external;
/**
* @notice Update merkle root for underperformer list
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @param newRoot New merkle root for underperformers
*/
function setUnderperformerRoot(bytes32 newRoot) external;
/**
* @notice Update merkle root for active miners (top-up authorization)
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @param newRoot New merkle root for active miners list
*/
function setActiveMinersRoot(bytes32 newRoot) external;
/**
* @notice Update merkle root for eviction list
* @dev Only callable by DEFAULT_ADMIN_ROLE
* @param newRoot New merkle root for eviction list
*/
function setEvictionRoot(bytes32 newRoot) external;
/**
* @notice Deposit from parent vault (for non-mining LPs)
* @dev Only callable by KEEPER_BOT role (parent vault must have this role)
* @param amount Asset amount to deposit
* @return received Amount actually received
*/
function depositFromParent(uint256 amount) external returns (uint256 received);
/**
* @notice Withdraw to parent vault
* @dev Only callable by KEEPER_BOT role (parent vault must have this role)
* @param amount Asset amount to withdraw
* @return withdrawn Amount actually withdrawn
*/
function withdrawToParent(uint256 amount) external returns (uint256 withdrawn);
/*//////////////////////////////////////////////////////////////
VIEW FUNCTIONS
//////////////////////////////////////////////////////////////*/
/**
* @notice Calculate lockId for (owner, poolId) pair
* @dev lockId = keccak256(abi.encode(owner, poolId))
* @dev One position per wallet per pool. For multiple miners, use different wallets.
*/
function lockIdOf(address owner, bytes32 poolId) external pure returns (bytes32);
/**
* @notice Get position details
* @return position Position struct (returns default values if not exists)
*/
function getPosition(address owner, bytes32 poolId) external view returns (Position memory position);
/**
* @notice Get all lockIds for a user
* @return lockIds Array of lockIds owned by user
*/
function getUserLocks(address owner) external view returns (bytes32[] memory lockIds);
/**
* @notice Check if position is currently locked
* @return locked True if lock period not expired
*/
function isLocked(address owner, bytes32 poolId) external view returns (bool locked);
/**
* @notice Get remaining cooldown time in seconds
* @return remaining Seconds until cooldown expires (0 if expired)
*/
function getCooldownRemaining(address owner, bytes32 poolId) external view returns (uint256 remaining);
/**
* @notice Check if position can be withdrawn
* @return canWithdraw True if both lock period and cooldown expired
*/
function canWithdraw(address owner, bytes32 poolId) external view returns (bool);
/**
* @notice Get contract configuration
*/
function asset() external view returns (address);
function poolId() external view returns (bytes32);
function maxLockDays() external view returns (uint64);
function cooldownDuration() external view returns (uint256);
function epochDuration() external view returns (uint256);
function performancePenalty() external view returns (uint256);
function minimumLockAmount() external view returns (uint256);
function underperformerRoot() external view returns (bytes32);
function activeMinersRoot() external view returns (bytes32);
/**
* @notice Get contract statistics
*/
function totalValueLocked() external view returns (uint256 tvl);
function totalPositions() external view returns (uint256 count);
function depositNonces(address owner) external view returns (uint256 nonce);
function totalLockedAmount() external view returns (uint256 locked);
/**
* @notice Get pool utilization rate
* @dev utilization = (totalLockedAmount * 10000) / totalValueLocked
* Where totalLockedAmount is funds locked by miners
* And totalValueLocked includes both miner locks and parent vault deposits
* @return utilization Utilization rate in basis points (0-10000)
*/
function getUtilization() external view returns (uint256 utilization);
/**
* @notice Get position from storage mapping directly
* @dev Use getPosition() instead for cleaner API
*/
function positions(bytes32 lockId)
external
view
returns (
uint256 amount,
uint64 lockDays,
uint64 start,
uint64 maxLockDays,
uint64 lastEpoch,
uint64 cooldownEnds,
bool exists
);
/**
* @notice Get EIP-712 domain separator
* @return Domain separator for signature verification
*/
function DOMAIN_SEPARATOR() external view returns (bytes32);
/**
* @notice Check if the vault is paused
* @return True if the vault is paused
*/
function paused() external view returns (bool);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title Roles
* @notice Role constants for Cartha protocol access control
* @dev Using uint8 for gas-efficient role management
*/
library Roles {
/**
* @notice Admin role - Protocol governance
* @dev Can grant/revoke all other roles, update critical parameters
*/
uint8 internal constant ADMIN = 0;
/**
* @notice Ejector role - Verifier bot
* @dev Can force exit deregistered or underperforming miners
*/
uint8 internal constant EJECTOR = 1;
/**
* @notice Keeper bot role
* @dev Can access funds and trigger liquidity events
*/
uint8 internal constant KEEPER_BOT = 2;
/**
* @notice Factory role - Vault deployment
* @dev Can deploy new vaults
*/
uint8 internal constant FACTORY = 3;
/**
* @notice Rescuer role - Emergency fund recovery
* @dev Can rescue stuck or lost funds from vault
*/
uint8 internal constant RESCUER = 4;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.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 reinitialization) 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 Pointer to storage slot. Allows integrators to override it with a custom storage location.
*
* NOTE: Consider following the ERC-7201 formula to derive storage locations.
*/
function _initializableStorageSlot() internal pure virtual returns (bytes32) {
return INITIALIZABLE_STORAGE;
}
/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
bytes32 slot = _initializableStorageSlot();
assembly {
$.slot := slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (proxy/utils/UUPSUpgradeable.sol)
pragma solidity ^0.8.22;
import {IERC1822Proxiable} from "../../interfaces/draft-IERC1822.sol";
import {ERC1967Utils} from "../ERC1967/ERC1967Utils.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.
*
* @custom:stateless
*/
abstract contract UUPSUpgradeable is 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();
_;
}
/**
* @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 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.
*/
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.4.0) (token/ERC20/IERC20.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
import {Initializable} from "@openzeppelin/contracts/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.5.0) (interfaces/draft-IERC6093.sol)
pragma solidity >=0.8.4;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-721.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (proxy/beacon/IBeacon.sol)
pragma solidity >=0.4.16;
/**
* @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.5.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(0x00, 0x00, calldatasize())
// Call the implementation.
// out and outsize are 0 because we don't know the size yet.
let result := delegatecall(gas(), implementation, 0x00, calldatasize(), 0x00, 0x00)
// Copy the returned data.
returndatacopy(0x00, 0x00, returndatasize())
switch result
// delegatecall returns 0 on error.
case 0 {
revert(0x00, returndatasize())
}
default {
return(0x00, 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.4.0) (proxy/ERC1967/ERC1967Utils.sol)
pragma solidity ^0.8.21;
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.5.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.24;
import {MessageHashUtils} from "@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol";
import {IERC5267} from "@openzeppelin/contracts/interfaces/IERC5267.sol";
import {Initializable} from "@openzeppelin/contracts/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: The upgradeable version of this contract does not use an immutable cache and recomputes the domain separator
* each time {_domainSeparatorV4} is called. That 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);
}
/// @inheritdoc IERC5267
function eip712Domain()
public
view
virtual
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
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
// OpenZeppelin Contracts (last updated v5.5.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.
*
* NOTE: This function only supports 65-byte signatures. ERC-2098 short signatures are rejected. This restriction
* is DEPRECATED and will be removed in v6.0. Developers SHOULD NOT use signatures as unique identifiers; use hash
* invalidation or nonces for replay protection.
*
* 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 Variant of {tryRecover} that takes a signature in calldata
*/
function tryRecoverCalldata(
bytes32 hash,
bytes calldata 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, calldata slices would work here, but are
// significantly more expensive (length check) than using calldataload in assembly.
assembly ("memory-safe") {
r := calldataload(signature.offset)
s := calldataload(add(signature.offset, 0x20))
v := byte(0, calldataload(add(signature.offset, 0x40)))
}
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.
*
* NOTE: This function only supports 65-byte signatures. ERC-2098 short signatures are rejected. This restriction
* is DEPRECATED and will be removed in v6.0. Developers SHOULD NOT use signatures as unique identifiers; use hash
* invalidation or nonces for replay protection.
*
* 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 Variant of {recover} that takes a signature in calldata
*/
function recoverCalldata(bytes32 hash, bytes calldata signature) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecoverCalldata(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 Parse a signature into its `v`, `r` and `s` components. Supports 65-byte and 64-byte (ERC-2098)
* formats. Returns (0,0,0) for invalid signatures.
*
* For 64-byte signatures, `v` is automatically normalized to 27 or 28.
* For 65-byte signatures, `v` is returned as-is and MUST already be 27 or 28 for use with ecrecover.
*
* Consider validating the result before use, or use {tryRecover}/{recover} which perform full validation.
*/
function parse(bytes memory signature) internal pure returns (uint8 v, bytes32 r, bytes32 s) {
assembly ("memory-safe") {
// Check the signature length
switch mload(signature)
// - case 65: r,s,v signature (standard)
case 65 {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
// - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098)
case 64 {
let vs := mload(add(signature, 0x40))
r := mload(add(signature, 0x20))
s := and(vs, shr(1, not(0)))
v := add(shr(255, vs), 27)
}
default {
r := 0
s := 0
v := 0
}
}
}
/**
* @dev Variant of {parse} that takes a signature in calldata
*/
function parseCalldata(bytes calldata signature) internal pure returns (uint8 v, bytes32 r, bytes32 s) {
assembly ("memory-safe") {
// Check the signature length
switch signature.length
// - case 65: r,s,v signature (standard)
case 65 {
r := calldataload(signature.offset)
s := calldataload(add(signature.offset, 0x20))
v := byte(0, calldataload(add(signature.offset, 0x40)))
}
// - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098)
case 64 {
let vs := calldataload(add(signature.offset, 0x20))
r := calldataload(signature.offset)
s := and(vs, shr(1, not(0)))
v := add(shr(255, vs), 27)
}
default {
r := 0
s := 0
v := 0
}
}
}
/**
* @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
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/MerkleProof.sol)
// This file was procedurally generated from scripts/generate/templates/MerkleProof.js.
pragma solidity ^0.8.20;
import {Hashes} from "./Hashes.sol";
/**
* @dev These functions deal with verification of Merkle Tree proofs.
*
* The tree and the proofs can be generated using our
* https://github.com/OpenZeppelin/merkle-tree[JavaScript library].
* You will find a quickstart guide in the readme.
*
* WARNING: You should avoid using leaf values that are 64 bytes long prior to
* hashing, or use a hash function other than keccak256 for hashing leaves.
* This is because the concatenation of a sorted pair of internal nodes in
* the Merkle tree could be reinterpreted as a leaf value.
* OpenZeppelin's JavaScript library generates Merkle trees that are safe
* against this attack out of the box.
*
* IMPORTANT: Consider memory side-effects when using custom hashing functions
* that access memory in an unsafe way.
*
* NOTE: This library supports proof verification for merkle trees built using
* custom _commutative_ hashing functions (i.e. `H(a, b) == H(b, a)`). Proving
* leaf inclusion in trees built using non-commutative hashing functions requires
* additional logic that is not supported by this library.
*/
library MerkleProof {
/**
*@dev The multiproof provided is not valid.
*/
error MerkleProofInvalidMultiproof();
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*
* This version handles proofs in memory with the default hashing function.
*/
function verify(bytes32[] memory proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
return processProof(proof, leaf) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leaves & pre-images are assumed to be sorted.
*
* This version handles proofs in memory with the default hashing function.
*/
function processProof(bytes32[] memory proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = Hashes.commutativeKeccak256(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*
* This version handles proofs in memory with a custom hashing function.
*/
function verify(
bytes32[] memory proof,
bytes32 root,
bytes32 leaf,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bool) {
return processProof(proof, leaf, hasher) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leaves & pre-images are assumed to be sorted.
*
* This version handles proofs in memory with a custom hashing function.
*/
function processProof(
bytes32[] memory proof,
bytes32 leaf,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = hasher(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*
* This version handles proofs in calldata with the default hashing function.
*/
function verifyCalldata(bytes32[] calldata proof, bytes32 root, bytes32 leaf) internal pure returns (bool) {
return processProofCalldata(proof, leaf) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leaves & pre-images are assumed to be sorted.
*
* This version handles proofs in calldata with the default hashing function.
*/
function processProofCalldata(bytes32[] calldata proof, bytes32 leaf) internal pure returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = Hashes.commutativeKeccak256(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Returns true if a `leaf` can be proved to be a part of a Merkle tree
* defined by `root`. For this, a `proof` must be provided, containing
* sibling hashes on the branch from the leaf to the root of the tree. Each
* pair of leaves and each pair of pre-images are assumed to be sorted.
*
* This version handles proofs in calldata with a custom hashing function.
*/
function verifyCalldata(
bytes32[] calldata proof,
bytes32 root,
bytes32 leaf,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bool) {
return processProofCalldata(proof, leaf, hasher) == root;
}
/**
* @dev Returns the rebuilt hash obtained by traversing a Merkle tree up
* from `leaf` using `proof`. A `proof` is valid if and only if the rebuilt
* hash matches the root of the tree. When processing the proof, the pairs
* of leaves & pre-images are assumed to be sorted.
*
* This version handles proofs in calldata with a custom hashing function.
*/
function processProofCalldata(
bytes32[] calldata proof,
bytes32 leaf,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bytes32) {
bytes32 computedHash = leaf;
for (uint256 i = 0; i < proof.length; i++) {
computedHash = hasher(computedHash, proof[i]);
}
return computedHash;
}
/**
* @dev Returns true if the `leaves` can be simultaneously proven to be a part of a Merkle tree defined by
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
*
* This version handles multiproofs in memory with the default hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*
* NOTE: Consider the case where `root == proof[0] && leaves.length == 0` as it will return `true`.
* The `leaves` must be validated independently. See {processMultiProof}.
*/
function multiProofVerify(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProof(proof, proofFlags, leaves) == root;
}
/**
* @dev Returns the root of a tree reconstructed from `leaves` and sibling nodes in `proof`. The reconstruction
* proceeds by incrementally reconstructing all inner nodes by combining a leaf/inner node with either another
* leaf/inner node or a proof sibling node, depending on whether each `proofFlags` item is true or false
* respectively.
*
* This version handles multiproofs in memory with the default hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree
* is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order they are in the
* tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
*
* NOTE: The _empty set_ (i.e. the case where `proof.length == 1 && leaves.length == 0`) is considered a no-op,
* and therefore a valid multiproof (i.e. it returns `proof[0]`). Consider disallowing this case if you're not
* validating the leaves elsewhere.
*/
function processMultiProof(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofFlagsLen = proofFlags.length;
// Check proof validity.
if (leavesLen + proof.length != proofFlagsLen + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](proofFlagsLen);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < proofFlagsLen; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = Hashes.commutativeKeccak256(a, b);
}
if (proofFlagsLen > 0) {
if (proofPos != proof.length) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[proofFlagsLen - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Returns true if the `leaves` can be simultaneously proven to be a part of a Merkle tree defined by
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
*
* This version handles multiproofs in memory with a custom hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*
* NOTE: Consider the case where `root == proof[0] && leaves.length == 0` as it will return `true`.
* The `leaves` must be validated independently. See {processMultiProof}.
*/
function multiProofVerify(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32 root,
bytes32[] memory leaves,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bool) {
return processMultiProof(proof, proofFlags, leaves, hasher) == root;
}
/**
* @dev Returns the root of a tree reconstructed from `leaves` and sibling nodes in `proof`. The reconstruction
* proceeds by incrementally reconstructing all inner nodes by combining a leaf/inner node with either another
* leaf/inner node or a proof sibling node, depending on whether each `proofFlags` item is true or false
* respectively.
*
* This version handles multiproofs in memory with a custom hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree
* is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order they are in the
* tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
*
* NOTE: The _empty set_ (i.e. the case where `proof.length == 1 && leaves.length == 0`) is considered a no-op,
* and therefore a valid multiproof (i.e. it returns `proof[0]`). Consider disallowing this case if you're not
* validating the leaves elsewhere.
*/
function processMultiProof(
bytes32[] memory proof,
bool[] memory proofFlags,
bytes32[] memory leaves,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofFlagsLen = proofFlags.length;
// Check proof validity.
if (leavesLen + proof.length != proofFlagsLen + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](proofFlagsLen);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < proofFlagsLen; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = hasher(a, b);
}
if (proofFlagsLen > 0) {
if (proofPos != proof.length) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[proofFlagsLen - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Returns true if the `leaves` can be simultaneously proven to be a part of a Merkle tree defined by
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
*
* This version handles multiproofs in calldata with the default hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*
* NOTE: Consider the case where `root == proof[0] && leaves.length == 0` as it will return `true`.
* The `leaves` must be validated independently. See {processMultiProofCalldata}.
*/
function multiProofVerifyCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32 root,
bytes32[] memory leaves
) internal pure returns (bool) {
return processMultiProofCalldata(proof, proofFlags, leaves) == root;
}
/**
* @dev Returns the root of a tree reconstructed from `leaves` and sibling nodes in `proof`. The reconstruction
* proceeds by incrementally reconstructing all inner nodes by combining a leaf/inner node with either another
* leaf/inner node or a proof sibling node, depending on whether each `proofFlags` item is true or false
* respectively.
*
* This version handles multiproofs in calldata with the default hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree
* is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order they are in the
* tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
*
* NOTE: The _empty set_ (i.e. the case where `proof.length == 1 && leaves.length == 0`) is considered a no-op,
* and therefore a valid multiproof (i.e. it returns `proof[0]`). Consider disallowing this case if you're not
* validating the leaves elsewhere.
*/
function processMultiProofCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32[] memory leaves
) internal pure returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofFlagsLen = proofFlags.length;
// Check proof validity.
if (leavesLen + proof.length != proofFlagsLen + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](proofFlagsLen);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < proofFlagsLen; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = Hashes.commutativeKeccak256(a, b);
}
if (proofFlagsLen > 0) {
if (proofPos != proof.length) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[proofFlagsLen - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
/**
* @dev Returns true if the `leaves` can be simultaneously proven to be a part of a Merkle tree defined by
* `root`, according to `proof` and `proofFlags` as described in {processMultiProof}.
*
* This version handles multiproofs in calldata with a custom hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. See {processMultiProof} for details.
*
* NOTE: Consider the case where `root == proof[0] && leaves.length == 0` as it will return `true`.
* The `leaves` must be validated independently. See {processMultiProofCalldata}.
*/
function multiProofVerifyCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32 root,
bytes32[] memory leaves,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bool) {
return processMultiProofCalldata(proof, proofFlags, leaves, hasher) == root;
}
/**
* @dev Returns the root of a tree reconstructed from `leaves` and sibling nodes in `proof`. The reconstruction
* proceeds by incrementally reconstructing all inner nodes by combining a leaf/inner node with either another
* leaf/inner node or a proof sibling node, depending on whether each `proofFlags` item is true or false
* respectively.
*
* This version handles multiproofs in calldata with a custom hashing function.
*
* CAUTION: Not all Merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree
* is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order they are in the
* tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
*
* NOTE: The _empty set_ (i.e. the case where `proof.length == 1 && leaves.length == 0`) is considered a no-op,
* and therefore a valid multiproof (i.e. it returns `proof[0]`). Consider disallowing this case if you're not
* validating the leaves elsewhere.
*/
function processMultiProofCalldata(
bytes32[] calldata proof,
bool[] calldata proofFlags,
bytes32[] memory leaves,
function(bytes32, bytes32) view returns (bytes32) hasher
) internal view returns (bytes32 merkleRoot) {
// This function rebuilds the root hash by traversing the tree up from the leaves. The root is rebuilt by
// consuming and producing values on a queue. The queue starts with the `leaves` array, then goes onto the
// `hashes` array. At the end of the process, the last hash in the `hashes` array should contain the root of
// the Merkle tree.
uint256 leavesLen = leaves.length;
uint256 proofFlagsLen = proofFlags.length;
// Check proof validity.
if (leavesLen + proof.length != proofFlagsLen + 1) {
revert MerkleProofInvalidMultiproof();
}
// The xxxPos values are "pointers" to the next value to consume in each array. All accesses are done using
// `xxx[xxxPos++]`, which return the current value and increment the pointer, thus mimicking a queue's "pop".
bytes32[] memory hashes = new bytes32[](proofFlagsLen);
uint256 leafPos = 0;
uint256 hashPos = 0;
uint256 proofPos = 0;
// At each step, we compute the next hash using two values:
// - a value from the "main queue". If not all leaves have been consumed, we get the next leaf, otherwise we
// get the next hash.
// - depending on the flag, either another value from the "main queue" (merging branches) or an element from the
// `proof` array.
for (uint256 i = 0; i < proofFlagsLen; i++) {
bytes32 a = leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++];
bytes32 b = proofFlags[i]
? (leafPos < leavesLen ? leaves[leafPos++] : hashes[hashPos++])
: proof[proofPos++];
hashes[i] = hasher(a, b);
}
if (proofFlagsLen > 0) {
if (proofPos != proof.length) {
revert MerkleProofInvalidMultiproof();
}
unchecked {
return hashes[proofFlagsLen - 1];
}
} else if (leavesLen > 0) {
return leaves[0];
} else {
return proof[0];
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "@openzeppelin/contracts/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 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();
_;
}
function __Pausable_init() internal onlyInitializing {
}
function __Pausable_init_unchained() internal onlyInitializing {
}
/**
* @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.5.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
/**
* @dev An operation with an ERC-20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
if (!_safeTransfer(token, to, value, true)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
if (!_safeTransferFrom(token, from, to, value, true)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Variant of {safeTransfer} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransfer(IERC20 token, address to, uint256 value) internal returns (bool) {
return _safeTransfer(token, to, value, false);
}
/**
* @dev Variant of {safeTransferFrom} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) internal returns (bool) {
return _safeTransferFrom(token, from, to, value, false);
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
if (!_safeApprove(token, spender, value, false)) {
if (!_safeApprove(token, spender, 0, true)) revert SafeERC20FailedOperation(address(token));
if (!_safeApprove(token, spender, value, true)) revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that relies on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that relies on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Oppositely, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity `token.transfer(to, value)` call, relaxing the requirement on the return value: the
* return value is optional (but if data is returned, it must not be false).
*
* @param token The token targeted by the call.
* @param to The recipient of the tokens
* @param value The amount of token to transfer
* @param bubble Behavior switch if the transfer call reverts: bubble the revert reason or return a false boolean.
*/
function _safeTransfer(IERC20 token, address to, uint256 value, bool bubble) private returns (bool success) {
bytes4 selector = IERC20.transfer.selector;
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(0x00, selector)
mstore(0x04, and(to, shr(96, not(0))))
mstore(0x24, value)
success := call(gas(), token, 0, 0x00, 0x44, 0x00, 0x20)
// if call success and return is true, all is good.
// otherwise (not success or return is not true), we need to perform further checks
if iszero(and(success, eq(mload(0x00), 1))) {
// if the call was a failure and bubble is enabled, bubble the error
if and(iszero(success), bubble) {
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
// if the return value is not true, then the call is only successful if:
// - the token address has code
// - the returndata is empty
success := and(success, and(iszero(returndatasize()), gt(extcodesize(token), 0)))
}
mstore(0x40, fmp)
}
}
/**
* @dev Imitates a Solidity `token.transferFrom(from, to, value)` call, relaxing the requirement on the return
* value: the return value is optional (but if data is returned, it must not be false).
*
* @param token The token targeted by the call.
* @param from The sender of the tokens
* @param to The recipient of the tokens
* @param value The amount of token to transfer
* @param bubble Behavior switch if the transfer call reverts: bubble the revert reason or return a false boolean.
*/
function _safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value,
bool bubble
) private returns (bool success) {
bytes4 selector = IERC20.transferFrom.selector;
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(0x00, selector)
mstore(0x04, and(from, shr(96, not(0))))
mstore(0x24, and(to, shr(96, not(0))))
mstore(0x44, value)
success := call(gas(), token, 0, 0x00, 0x64, 0x00, 0x20)
// if call success and return is true, all is good.
// otherwise (not success or return is not true), we need to perform further checks
if iszero(and(success, eq(mload(0x00), 1))) {
// if the call was a failure and bubble is enabled, bubble the error
if and(iszero(success), bubble) {
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
// if the return value is not true, then the call is only successful if:
// - the token address has code
// - the returndata is empty
success := and(success, and(iszero(returndatasize()), gt(extcodesize(token), 0)))
}
mstore(0x40, fmp)
mstore(0x60, 0)
}
}
/**
* @dev Imitates a Solidity `token.approve(spender, value)` call, relaxing the requirement on the return value:
* the return value is optional (but if data is returned, it must not be false).
*
* @param token The token targeted by the call.
* @param spender The spender of the tokens
* @param value The amount of token to transfer
* @param bubble Behavior switch if the transfer call reverts: bubble the revert reason or return a false boolean.
*/
function _safeApprove(IERC20 token, address spender, uint256 value, bool bubble) private returns (bool success) {
bytes4 selector = IERC20.approve.selector;
assembly ("memory-safe") {
let fmp := mload(0x40)
mstore(0x00, selector)
mstore(0x04, and(spender, shr(96, not(0))))
mstore(0x24, value)
success := call(gas(), token, 0, 0x00, 0x44, 0x00, 0x20)
// if call success and return is true, all is good.
// otherwise (not success or return is not true), we need to perform further checks
if iszero(and(success, eq(mload(0x00), 1))) {
// if the call was a failure and bubble is enabled, bubble the error
if and(iszero(success), bubble) {
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
// if the return value is not true, then the call is only successful if:
// - the token address has code
// - the returndata is empty
success := and(success, and(iszero(returndatasize()), gt(extcodesize(token), 0)))
}
mstore(0x40, fmp)
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title ICarthaVaultEvents
* @notice Events emitted by CarthaVault for off-chain indexing and validator scoring
*/
interface ICarthaVaultEvents {
/**
* @notice Emitted when a new position is created
* @dev Validators replay this event to track liquidity entries
* @param lockId Unique position identifier: keccak256(owner, poolId)
* @param owner Miner's EVM address
* @param poolId Market identifier (e.g., keccak256("EUR/USD"))
* @param vault This vault's address
* @param amount USDC deposited (6 decimals)
* @param start Block timestamp of creation
* @param lockDays Lock duration in days
*/
event LockCreated(
bytes32 indexed lockId,
address indexed owner,
bytes32 indexed poolId,
address vault,
uint256 amount,
uint64 start,
uint64 lockDays
);
/**
* @notice Emitted when position is topped up or lock extended
* @param lockId Position identifier
* @param deltaAmount Change in amount (positive = top-up, negative = partial release)
* @param newLockDays Updated lock duration
*/
event LockUpdated(bytes32 indexed lockId, int256 deltaAmount, uint64 newLockDays);
/**
* @notice Emitted when position is fully released by user
* @param lockId Position identifier
* @param to Recipient address (usually owner)
* @param amount USDC withdrawn
*/
event LockReleased(bytes32 indexed lockId, address indexed to, uint256 amount);
/**
* @notice Emitted when miner is forcefully exited
* @dev Used for both deregistration (no penalty) and underperformance (with penalty)
* @param lockId Position identifier
* @param owner Miner's EVM address
* @param poolId Market identifier
* @param amount Total USDC in position (before penalty)
* @param epoch Epoch number when eviction occurred
*/
event Evicted(bytes32 indexed lockId, address indexed owner, bytes32 indexed poolId, uint256 amount, uint64 epoch);
/**
* @notice Emitted when penalty is applied to underperformer
* @param owner Miner's EVM address
* @param poolId Market identifier
* @param penaltyAmount USDC penalty (stays in vault)
* @param remainingAmount USDC returned to owner
*/
event PenaltyApplied(address indexed owner, bytes32 indexed poolId, uint256 penaltyAmount, uint256 remainingAmount);
/**
* @notice Emitted when funds are rescued by rescuer role
* @param token Token address rescued
* @param recipient Address receiving funds
* @param amount Amount rescued
*/
event FundsRescued(address indexed token, address indexed recipient, uint256 amount);
// Configuration events
event MaxLockDaysUpdated(uint64 newMax);
event MinLockAmountUpdated(uint256 newMin);
event CooldownDurationUpdated(uint256 newDuration);
event PerformancePenaltyUpdated(uint256 newPenalty);
event UnderperformerRootUpdated(bytes32 newRoot);
event ActiveMinersRootUpdated(bytes32 newRoot);
event VerifierSignerUpdated(address newSigner);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (token/ERC20/extensions/ERC4626.sol)
pragma solidity ^0.8.24;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {ERC20Upgradeable} from "../ERC20Upgradeable.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IERC4626} from "@openzeppelin/contracts/interfaces/IERC4626.sol";
import {LowLevelCall} from "@openzeppelin/contracts/utils/LowLevelCall.sol";
import {Memory} from "@openzeppelin/contracts/utils/Memory.sol";
import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
/**
* @dev Implementation of the ERC-4626 "Tokenized Vault Standard" as defined in
* https://eips.ethereum.org/EIPS/eip-4626[ERC-4626].
*
* This extension allows the minting and burning of "shares" (represented using the ERC-20 inheritance) in exchange for
* underlying "assets" through standardized {deposit}, {mint}, {redeem} and {burn} workflows. This contract extends
* the ERC-20 standard. Any additional extensions included along it would affect the "shares" token represented by this
* contract and not the "assets" token which is an independent contract.
*
* [CAUTION]
* ====
* In empty (or nearly empty) ERC-4626 vaults, deposits are at high risk of being stolen through frontrunning
* with a "donation" to the vault that inflates the price of a share. This is variously known as a donation or inflation
* attack and is essentially a problem of slippage. Vault deployers can protect against this attack by making an initial
* deposit of a non-trivial amount of the asset, such that price manipulation becomes infeasible. Withdrawals may
* similarly be affected by slippage. Users can protect against this attack as well as unexpected slippage in general by
* verifying the amount received is as expected, using a wrapper that performs these checks such as
* https://github.com/fei-protocol/ERC4626#erc4626router-and-base[ERC4626Router].
*
* Since v4.9, this implementation introduces configurable virtual assets and shares to help developers mitigate that risk.
* The `_decimalsOffset()` corresponds to an offset in the decimal representation between the underlying asset's decimals
* and the vault decimals. This offset also determines the rate of virtual shares to virtual assets in the vault, which
* itself determines the initial exchange rate. While not fully preventing the attack, analysis shows that the default
* offset (0) makes it non-profitable even if an attacker is able to capture value from multiple user deposits, as a result
* of the value being captured by the virtual shares (out of the attacker's donation) matching the attacker's expected gains.
* With a larger offset, the attack becomes orders of magnitude more expensive than it is profitable. More details about the
* underlying math can be found xref:ROOT:erc4626.adoc#inflation-attack[here].
*
* The drawback of this approach is that the virtual shares do capture (a very small) part of the value being accrued
* to the vault. Also, if the vault experiences losses, the users try to exit the vault, the virtual shares and assets
* will cause the first user to exit to experience reduced losses in detriment to the last users that will experience
* bigger losses. Developers willing to revert back to the pre-v4.9 behavior just need to override the
* `_convertToShares` and `_convertToAssets` functions.
*
* To learn more, check out our xref:ROOT:erc4626.adoc[ERC-4626 guide].
* ====
*
* [NOTE]
* ====
* When overriding this contract, some elements must be considered:
*
* * When overriding the behavior of the deposit or withdraw mechanisms, it is recommended to override the internal
* functions. Overriding {_deposit} automatically affects both {deposit} and {mint}. Similarly, overriding {_withdraw}
* automatically affects both {withdraw} and {redeem}. Overall it is not recommended to override the public facing
* functions since that could lead to inconsistent behaviors between the {deposit} and {mint} or between {withdraw} and
* {redeem}, which is documented to have lead to loss of funds.
*
* * Overrides to the deposit or withdraw mechanism must be reflected in the preview functions as well.
*
* * {maxWithdraw} depends on {maxRedeem}. Therefore, overriding {maxRedeem} only is enough. On the other hand,
* overriding {maxWithdraw} only would have no effect on {maxRedeem}, and could create an inconsistency between the two
* functions.
*
* * If {previewRedeem} is overridden to revert, {maxWithdraw} must be overridden as necessary to ensure it
* always return successfully.
* ====
*/
abstract contract ERC4626Upgradeable is Initializable, ERC20Upgradeable, IERC4626 {
using Math for uint256;
/// @custom:storage-location erc7201:openzeppelin.storage.ERC4626
struct ERC4626Storage {
IERC20 _asset;
uint8 _underlyingDecimals;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ERC4626")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ERC4626StorageLocation = 0x0773e532dfede91f04b12a73d3d2acd361424f41f76b4fb79f090161e36b4e00;
function _getERC4626Storage() private pure returns (ERC4626Storage storage $) {
assembly {
$.slot := ERC4626StorageLocation
}
}
/**
* @dev Attempted to deposit more assets than the max amount for `receiver`.
*/
error ERC4626ExceededMaxDeposit(address receiver, uint256 assets, uint256 max);
/**
* @dev Attempted to mint more shares than the max amount for `receiver`.
*/
error ERC4626ExceededMaxMint(address receiver, uint256 shares, uint256 max);
/**
* @dev Attempted to withdraw more assets than the max amount for `receiver`.
*/
error ERC4626ExceededMaxWithdraw(address owner, uint256 assets, uint256 max);
/**
* @dev Attempted to redeem more shares than the max amount for `receiver`.
*/
error ERC4626ExceededMaxRedeem(address owner, uint256 shares, uint256 max);
/**
* @dev Set the underlying asset contract. This must be an ERC20-compatible contract (ERC-20 or ERC-777).
*/
function __ERC4626_init(IERC20 asset_) internal onlyInitializing {
__ERC4626_init_unchained(asset_);
}
function __ERC4626_init_unchained(IERC20 asset_) internal onlyInitializing {
ERC4626Storage storage $ = _getERC4626Storage();
(bool success, uint8 assetDecimals) = _tryGetAssetDecimals(asset_);
$._underlyingDecimals = success ? assetDecimals : 18;
$._asset = asset_;
}
/**
* @dev Attempts to fetch the asset decimals. A return value of false indicates that the attempt failed in some way.
*/
function _tryGetAssetDecimals(IERC20 asset_) private view returns (bool ok, uint8 assetDecimals) {
Memory.Pointer ptr = Memory.getFreeMemoryPointer();
(bool success, bytes32 returnedDecimals, ) = LowLevelCall.staticcallReturn64Bytes(
address(asset_),
abi.encodeCall(IERC20Metadata.decimals, ())
);
Memory.setFreeMemoryPointer(ptr);
return
(success && LowLevelCall.returnDataSize() >= 32 && uint256(returnedDecimals) <= type(uint8).max)
? (true, uint8(uint256(returnedDecimals)))
: (false, 0);
}
/**
* @dev Decimals are computed by adding the decimal offset on top of the underlying asset's decimals. This
* "original" value is cached during construction of the vault contract. If this read operation fails (e.g., the
* asset has not been created yet), a default of 18 is used to represent the underlying asset's decimals.
*
* See {IERC20Metadata-decimals}.
*/
function decimals() public view virtual override(IERC20Metadata, ERC20Upgradeable) returns (uint8) {
ERC4626Storage storage $ = _getERC4626Storage();
return $._underlyingDecimals + _decimalsOffset();
}
/// @inheritdoc IERC4626
function asset() public view virtual returns (address) {
ERC4626Storage storage $ = _getERC4626Storage();
return address($._asset);
}
/// @inheritdoc IERC4626
function totalAssets() public view virtual returns (uint256) {
return IERC20(asset()).balanceOf(address(this));
}
/// @inheritdoc IERC4626
function convertToShares(uint256 assets) public view virtual returns (uint256) {
return _convertToShares(assets, Math.Rounding.Floor);
}
/// @inheritdoc IERC4626
function convertToAssets(uint256 shares) public view virtual returns (uint256) {
return _convertToAssets(shares, Math.Rounding.Floor);
}
/// @inheritdoc IERC4626
function maxDeposit(address) public view virtual returns (uint256) {
return type(uint256).max;
}
/// @inheritdoc IERC4626
function maxMint(address) public view virtual returns (uint256) {
return type(uint256).max;
}
/// @inheritdoc IERC4626
function maxWithdraw(address owner) public view virtual returns (uint256) {
return previewRedeem(maxRedeem(owner));
}
/// @inheritdoc IERC4626
function maxRedeem(address owner) public view virtual returns (uint256) {
return balanceOf(owner);
}
/// @inheritdoc IERC4626
function previewDeposit(uint256 assets) public view virtual returns (uint256) {
return _convertToShares(assets, Math.Rounding.Floor);
}
/// @inheritdoc IERC4626
function previewMint(uint256 shares) public view virtual returns (uint256) {
return _convertToAssets(shares, Math.Rounding.Ceil);
}
/// @inheritdoc IERC4626
function previewWithdraw(uint256 assets) public view virtual returns (uint256) {
return _convertToShares(assets, Math.Rounding.Ceil);
}
/// @inheritdoc IERC4626
function previewRedeem(uint256 shares) public view virtual returns (uint256) {
return _convertToAssets(shares, Math.Rounding.Floor);
}
/// @inheritdoc IERC4626
function deposit(uint256 assets, address receiver) public virtual returns (uint256) {
uint256 maxAssets = maxDeposit(receiver);
if (assets > maxAssets) {
revert ERC4626ExceededMaxDeposit(receiver, assets, maxAssets);
}
uint256 shares = previewDeposit(assets);
_deposit(_msgSender(), receiver, assets, shares);
return shares;
}
/// @inheritdoc IERC4626
function mint(uint256 shares, address receiver) public virtual returns (uint256) {
uint256 maxShares = maxMint(receiver);
if (shares > maxShares) {
revert ERC4626ExceededMaxMint(receiver, shares, maxShares);
}
uint256 assets = previewMint(shares);
_deposit(_msgSender(), receiver, assets, shares);
return assets;
}
/// @inheritdoc IERC4626
function withdraw(uint256 assets, address receiver, address owner) public virtual returns (uint256) {
uint256 maxAssets = maxWithdraw(owner);
if (assets > maxAssets) {
revert ERC4626ExceededMaxWithdraw(owner, assets, maxAssets);
}
uint256 shares = previewWithdraw(assets);
_withdraw(_msgSender(), receiver, owner, assets, shares);
return shares;
}
/// @inheritdoc IERC4626
function redeem(uint256 shares, address receiver, address owner) public virtual returns (uint256) {
uint256 maxShares = maxRedeem(owner);
if (shares > maxShares) {
revert ERC4626ExceededMaxRedeem(owner, shares, maxShares);
}
uint256 assets = previewRedeem(shares);
_withdraw(_msgSender(), receiver, owner, assets, shares);
return assets;
}
/**
* @dev Internal conversion function (from assets to shares) with support for rounding direction.
*/
function _convertToShares(uint256 assets, Math.Rounding rounding) internal view virtual returns (uint256) {
return assets.mulDiv(totalSupply() + 10 ** _decimalsOffset(), totalAssets() + 1, rounding);
}
/**
* @dev Internal conversion function (from shares to assets) with support for rounding direction.
*/
function _convertToAssets(uint256 shares, Math.Rounding rounding) internal view virtual returns (uint256) {
return shares.mulDiv(totalAssets() + 1, totalSupply() + 10 ** _decimalsOffset(), rounding);
}
/**
* @dev Deposit/mint common workflow.
*/
function _deposit(address caller, address receiver, uint256 assets, uint256 shares) internal virtual {
// If asset() is ERC-777, `transferFrom` can trigger a reentrancy BEFORE the transfer happens through the
// `tokensToSend` hook. On the other hand, the `tokenReceived` hook, that is triggered after the transfer,
// calls the vault, which is assumed not malicious.
//
// Conclusion: we need to do the transfer before we mint so that any reentrancy would happen before the
// assets are transferred and before the shares are minted, which is a valid state.
// slither-disable-next-line reentrancy-no-eth
SafeERC20.safeTransferFrom(IERC20(asset()), caller, address(this), assets);
_mint(receiver, shares);
emit Deposit(caller, receiver, assets, shares);
}
/**
* @dev Withdraw/redeem common workflow.
*/
function _withdraw(
address caller,
address receiver,
address owner,
uint256 assets,
uint256 shares
) internal virtual {
if (caller != owner) {
_spendAllowance(owner, caller, shares);
}
// If asset() is ERC-777, `transfer` can trigger a reentrancy AFTER the transfer happens through the
// `tokensReceived` hook. On the other hand, the `tokensToSend` hook, that is triggered before the transfer,
// calls the vault, which is assumed not malicious.
//
// Conclusion: we need to do the transfer after the burn so that any reentrancy would happen after the
// shares are burned and after the assets are transferred, which is a valid state.
_burn(owner, shares);
SafeERC20.safeTransfer(IERC20(asset()), receiver, assets);
emit Withdraw(caller, receiver, owner, assets, shares);
}
function _decimalsOffset() internal view virtual returns (uint8) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (interfaces/IERC4626.sol)
pragma solidity >=0.6.2;
import {IERC20} from "../token/ERC20/IERC20.sol";
import {IERC20Metadata} from "../token/ERC20/extensions/IERC20Metadata.sol";
/**
* @dev Interface of the ERC-4626 "Tokenized Vault Standard", as defined in
* https://eips.ethereum.org/EIPS/eip-4626[ERC-4626].
*/
interface IERC4626 is IERC20, IERC20Metadata {
event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);
event Withdraw(
address indexed sender,
address indexed receiver,
address indexed owner,
uint256 assets,
uint256 shares
);
/**
* @dev Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
*
* - MUST be an ERC-20 token contract.
* - MUST NOT revert.
*/
function asset() external view returns (address assetTokenAddress);
/**
* @dev Returns the total amount of the underlying asset that is “managed” by Vault.
*
* - SHOULD include any compounding that occurs from yield.
* - MUST be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT revert.
*/
function totalAssets() external view returns (uint256 totalManagedAssets);
/**
* @dev Returns the amount of shares that the Vault would exchange for the amount of assets provided, in an ideal
* scenario where all the conditions are met.
*
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT show any variations depending on the caller.
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
* - MUST NOT revert.
*
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
* from.
*/
function convertToShares(uint256 assets) external view returns (uint256 shares);
/**
* @dev Returns the amount of assets that the Vault would exchange for the amount of shares provided, in an ideal
* scenario where all the conditions are met.
*
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault.
* - MUST NOT show any variations depending on the caller.
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
* - MUST NOT revert.
*
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and
* from.
*/
function convertToAssets(uint256 shares) external view returns (uint256 assets);
/**
* @dev Returns the maximum amount of the underlying asset that can be deposited into the Vault for the receiver,
* through a deposit call.
*
* - MUST return a limited value if receiver is subject to some deposit limit.
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
* - MUST NOT revert.
*/
function maxDeposit(address receiver) external view returns (uint256 maxAssets);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given
* current on-chain conditions.
*
* - MUST return as close to and no more than the exact amount of Vault shares that would be minted in a deposit
* call in the same transaction. I.e. deposit should return the same or more shares as previewDeposit if called
* in the same transaction.
* - MUST NOT account for deposit limits like those returned from maxDeposit and should always act as though the
* deposit would be accepted, regardless if the user has enough tokens approved, etc.
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToShares and previewDeposit SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewDeposit(uint256 assets) external view returns (uint256 shares);
/**
* @dev Deposit `assets` underlying tokens and send the corresponding number of vault shares (`shares`) to `receiver`.
*
* - MUST emit the Deposit event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* deposit execution, and are accounted for during deposit.
* - MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function deposit(uint256 assets, address receiver) external returns (uint256 shares);
/**
* @dev Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.
* - MUST return a limited value if receiver is subject to some mint limit.
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
* - MUST NOT revert.
*/
function maxMint(address receiver) external view returns (uint256 maxShares);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given
* current on-chain conditions.
*
* - MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call
* in the same transaction. I.e. mint should return the same or fewer assets as previewMint if called in the
* same transaction.
* - MUST NOT account for mint limits like those returned from maxMint and should always act as though the mint
* would be accepted, regardless if the user has enough tokens approved, etc.
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by minting.
*/
function previewMint(uint256 shares) external view returns (uint256 assets);
/**
* @dev Mints exactly `shares` vault shares to `receiver` in exchange for `assets` underlying tokens.
*
* - MUST emit the Deposit event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint
* execution, and are accounted for during mint.
* - MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not
* approving enough underlying tokens to the Vault contract, etc).
*
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
*/
function mint(uint256 shares, address receiver) external returns (uint256 assets);
/**
* @dev Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the
* Vault, through a withdraw call.
*
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
* - MUST NOT revert.
*/
function maxWithdraw(address owner) external view returns (uint256 maxAssets);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block,
* given current on-chain conditions.
*
* - MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw
* call in the same transaction. I.e. withdraw should return the same or fewer shares as previewWithdraw if
* called
* in the same transaction.
* - MUST NOT account for withdrawal limits like those returned from maxWithdraw and should always act as though
* the withdrawal would be accepted, regardless if the user has enough shares, etc.
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by depositing.
*/
function previewWithdraw(uint256 assets) external view returns (uint256 shares);
/**
* @dev Burns shares from owner and sends exactly assets of underlying tokens to receiver.
*
* - MUST emit the Withdraw event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* withdraw execution, and are accounted for during withdraw.
* - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner
* not having enough shares, etc).
*
* Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares);
/**
* @dev Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault,
* through a redeem call.
*
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock.
* - MUST return balanceOf(owner) if owner is not subject to any withdrawal limit or timelock.
* - MUST NOT revert.
*/
function maxRedeem(address owner) external view returns (uint256 maxShares);
/**
* @dev Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block,
* given current on-chain conditions.
*
* - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call
* in the same transaction. I.e. redeem should return the same or more assets as previewRedeem if called in the
* same transaction.
* - MUST NOT account for redemption limits like those returned from maxRedeem and should always act as though the
* redemption would be accepted, regardless if the user has enough shares, etc.
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
* - MUST NOT revert.
*
* NOTE: any unfavorable discrepancy between convertToAssets and previewRedeem SHOULD be considered slippage in
* share price or some other type of condition, meaning the depositor will lose assets by redeeming.
*/
function previewRedeem(uint256 shares) external view returns (uint256 assets);
/**
* @dev Burns exactly shares from owner and sends assets of underlying tokens to receiver.
*
* - MUST emit the Withdraw event.
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the
* redeem execution, and are accounted for during redeem.
* - MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner
* not having enough shares, etc).
*
* NOTE: some implementations will require pre-requesting to the Vault before a withdrawal may be performed.
* Those methods should be performed separately.
*/
function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title ICarthaParentVaultErrors
* @notice Error definitions for CarthaParentVault
*/
interface ICarthaParentVaultErrors {
error Unauthorized();
error InvalidAmount();
error InvalidVault();
error InvalidAllocation();
error PoolAlreadyExists();
error PoolNotFound();
error PoolNotActive();
error InsufficientShares();
error RebalanceTooSoon();
error NoActivePools();
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/**
* @title ICarthaVaultErrors
* @notice Custom errors for gas-efficient reverts
*/
interface ICarthaVaultErrors {
// Configuration errors
error InvalidAsset();
error InvalidPoolId();
error InvalidAccessControl();
error InvalidRecipient();
error InvalidCooldown();
error InvalidPenalty();
// Deposit errors
error AmountTooLow();
error AmountTooSmall();
error InvalidAmount();
error InvalidLockDays();
error InvalidLockDuration();
error CannotDecreaseLock();
error ExceedsMaxLock();
error TransferFailed();
// Registration enforcement errors
error InvalidSignature();
error InvalidNonce();
error SignatureExpired();
error InvalidTimestamp();
// Position errors
error PositionNotFound();
error PositionAlreadyExists();
error InsufficientBalance();
error InsufficientShares();
error PositionLocked();
error CooldownActive();
error CooldownNotExpired();
error MustIncreaseLock();
// Admin errors
error InvalidMerkleProof();
error InvalidParameter();
error InvalidRoot();
error Unauthorized();
error NotRegistered();
error AlreadyEvicted();
// Rescue errors
error CannotRescueVaultAsset();
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/draft-IERC1822.sol)
pragma solidity >=0.4.16;
/**
* @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.4.0) (interfaces/IERC1967.sol)
pragma solidity >=0.4.11;
/**
* @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.5.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
import {LowLevelCall} from "./LowLevelCall.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);
}
if (LowLevelCall.callNoReturn(recipient, amount, "")) {
// call successful, nothing to do
return;
} else if (LowLevelCall.returnDataSize() > 0) {
LowLevelCall.bubbleRevert();
} else {
revert Errors.FailedCall();
}
}
/**
* @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 = LowLevelCall.callNoReturn(target, value, data);
if (success && (LowLevelCall.returnDataSize() > 0 || target.code.length > 0)) {
return LowLevelCall.returnData();
} else if (success) {
revert AddressEmptyCode(target);
} else if (LowLevelCall.returnDataSize() > 0) {
LowLevelCall.bubbleRevert();
} else {
revert Errors.FailedCall();
}
}
/**
* @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 = LowLevelCall.staticcallNoReturn(target, data);
if (success && (LowLevelCall.returnDataSize() > 0 || target.code.length > 0)) {
return LowLevelCall.returnData();
} else if (success) {
revert AddressEmptyCode(target);
} else if (LowLevelCall.returnDataSize() > 0) {
LowLevelCall.bubbleRevert();
} else {
revert Errors.FailedCall();
}
}
/**
* @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 = LowLevelCall.delegatecallNoReturn(target, data);
if (success && (LowLevelCall.returnDataSize() > 0 || target.code.length > 0)) {
return LowLevelCall.returnData();
} else if (success) {
revert AddressEmptyCode(target);
} else if (LowLevelCall.returnDataSize() > 0) {
LowLevelCall.bubbleRevert();
} else {
revert Errors.FailedCall();
}
}
/**
* @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.
*
* NOTE: This function is DEPRECATED and may be removed in the next major release.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
// 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 (success && (returndata.length > 0 || target.code.length > 0)) {
return returndata;
} else if (success) {
revert AddressEmptyCode(target);
} else if (returndata.length > 0) {
LowLevelCall.bubbleRevert(returndata);
} else {
revert Errors.FailedCall();
}
}
/**
* @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) {
return returndata;
} else if (returndata.length > 0) {
LowLevelCall.bubbleRevert(returndata);
} 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.5.0) (utils/cryptography/MessageHashUtils.sol)
pragma solidity ^0.8.24;
import {Strings} from "../Strings.sol";
/**
* @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
*
* The library provides methods for generating a hash of a message that conforms to the
* https://eips.ethereum.org/EIPS/eip-191[ERC-191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
* specifications.
*/
library MessageHashUtils {
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing a bytes32 `messageHash` with
* `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the
* hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method.
*
* NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with
* keccak256, although any bytes32 value can be safely used because the final digest will
* be re-hashed.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
}
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing an arbitrary `message` with
* `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the
* hash signed when using the https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_sign[`eth_sign`] JSON-RPC method.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) {
return
keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message));
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x00` (data with intended validator).
*
* The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
* `validator` address. Then hashing the result.
*
* See {ECDSA-recover}.
*/
function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(hex"19_00", validator, data));
}
/**
* @dev Variant of {toDataWithIntendedValidatorHash-address-bytes} optimized for cases where `data` is a bytes32.
*/
function toDataWithIntendedValidatorHash(
address validator,
bytes32 messageHash
) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, hex"19_00")
mstore(0x02, shl(96, validator))
mstore(0x16, messageHash)
digest := keccak256(0x00, 0x36)
}
}
/**
* @dev Returns the keccak256 digest of an EIP-712 typed data (ERC-191 version `0x01`).
*
* The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
* `\x19\x01` and hashing the result. It corresponds to the hash signed by the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712.
*
* See {ECDSA-recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
let ptr := mload(0x40)
mstore(ptr, hex"19_01")
mstore(add(ptr, 0x02), domainSeparator)
mstore(add(ptr, 0x22), structHash)
digest := keccak256(ptr, 0x42)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC5267.sol)
pragma solidity >=0.4.16;
interface IERC5267 {
/**
* @dev MAY be emitted to signal that the domain could have changed.
*/
event EIP712DomainChanged();
/**
* @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
* signature.
*/
function eip712Domain()
external
view
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/cryptography/Hashes.sol)
pragma solidity ^0.8.20;
/**
* @dev Library of standard hash functions.
*
* _Available since v5.1._
*/
library Hashes {
/**
* @dev Commutative Keccak256 hash of a sorted pair of bytes32. Frequently used when working with merkle proofs.
*
* NOTE: Equivalent to the `standardNodeHash` in our https://github.com/OpenZeppelin/merkle-tree[JavaScript library].
*/
function commutativeKeccak256(bytes32 a, bytes32 b) internal pure returns (bytes32) {
return a < b ? efficientKeccak256(a, b) : efficientKeccak256(b, a);
}
/**
* @dev Implementation of keccak256(abi.encode(a, b)) that doesn't allocate or expand memory.
*/
function efficientKeccak256(bytes32 a, bytes32 b) internal pure returns (bytes32 value) {
assembly ("memory-safe") {
mstore(0x00, a)
mstore(0x20, b)
value := keccak256(0x00, 0x40)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC1363.sol)
pragma solidity >=0.6.2;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (utils/LowLevelCall.sol)
pragma solidity ^0.8.20;
/**
* @dev Library of low level call functions that implement different calling strategies to deal with the return data.
*
* WARNING: Using this library requires an advanced understanding of Solidity and how the EVM works. It is recommended
* to use the {Address} library instead.
*/
library LowLevelCall {
/// @dev Performs a Solidity function call using a low level `call` and ignoring the return data.
function callNoReturn(address target, bytes memory data) internal returns (bool success) {
return callNoReturn(target, 0, data);
}
/// @dev Same as {callNoReturn}, but allows to specify the value to be sent in the call.
function callNoReturn(address target, uint256 value, bytes memory data) internal returns (bool success) {
assembly ("memory-safe") {
success := call(gas(), target, value, add(data, 0x20), mload(data), 0x00, 0x00)
}
}
/// @dev Performs a Solidity function call using a low level `call` and returns the first 64 bytes of the result
/// in the scratch space of memory. Useful for functions that return a tuple of single-word values.
///
/// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
/// and this function doesn't zero it out.
function callReturn64Bytes(
address target,
bytes memory data
) internal returns (bool success, bytes32 result1, bytes32 result2) {
return callReturn64Bytes(target, 0, data);
}
/// @dev Same as {callReturnBytes32Pair}, but allows to specify the value to be sent in the call.
function callReturn64Bytes(
address target,
uint256 value,
bytes memory data
) internal returns (bool success, bytes32 result1, bytes32 result2) {
assembly ("memory-safe") {
success := call(gas(), target, value, add(data, 0x20), mload(data), 0x00, 0x40)
result1 := mload(0x00)
result2 := mload(0x20)
}
}
/// @dev Performs a Solidity function call using a low level `staticcall` and ignoring the return data.
function staticcallNoReturn(address target, bytes memory data) internal view returns (bool success) {
assembly ("memory-safe") {
success := staticcall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x00)
}
}
/// @dev Performs a Solidity function call using a low level `staticcall` and returns the first 64 bytes of the result
/// in the scratch space of memory. Useful for functions that return a tuple of single-word values.
///
/// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
/// and this function doesn't zero it out.
function staticcallReturn64Bytes(
address target,
bytes memory data
) internal view returns (bool success, bytes32 result1, bytes32 result2) {
assembly ("memory-safe") {
success := staticcall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x40)
result1 := mload(0x00)
result2 := mload(0x20)
}
}
/// @dev Performs a Solidity function call using a low level `delegatecall` and ignoring the return data.
function delegatecallNoReturn(address target, bytes memory data) internal returns (bool success) {
assembly ("memory-safe") {
success := delegatecall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x00)
}
}
/// @dev Performs a Solidity function call using a low level `delegatecall` and returns the first 64 bytes of the result
/// in the scratch space of memory. Useful for functions that return a tuple of single-word values.
///
/// WARNING: Do not assume that the results are zero if `success` is false. Memory can be already allocated
/// and this function doesn't zero it out.
function delegatecallReturn64Bytes(
address target,
bytes memory data
) internal returns (bool success, bytes32 result1, bytes32 result2) {
assembly ("memory-safe") {
success := delegatecall(gas(), target, add(data, 0x20), mload(data), 0x00, 0x40)
result1 := mload(0x00)
result2 := mload(0x20)
}
}
/// @dev Returns the size of the return data buffer.
function returnDataSize() internal pure returns (uint256 size) {
assembly ("memory-safe") {
size := returndatasize()
}
}
/// @dev Returns a buffer containing the return data from the last call.
function returnData() internal pure returns (bytes memory result) {
assembly ("memory-safe") {
result := mload(0x40)
mstore(result, returndatasize())
returndatacopy(add(result, 0x20), 0x00, returndatasize())
mstore(0x40, add(result, add(0x20, returndatasize())))
}
}
/// @dev Revert with the return data from the last call.
function bubbleRevert() internal pure {
assembly ("memory-safe") {
let fmp := mload(0x40)
returndatacopy(fmp, 0x00, returndatasize())
revert(fmp, returndatasize())
}
}
function bubbleRevert(bytes memory returndata) internal pure {
assembly ("memory-safe") {
revert(add(returndata, 0x20), mload(returndata))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (utils/Memory.sol)
pragma solidity ^0.8.24;
import {Panic} from "./Panic.sol";
import {Math} from "./math/Math.sol";
/**
* @dev Utilities to manipulate memory.
*
* Memory is a contiguous and dynamic byte array in which Solidity stores non-primitive types.
* This library provides functions to manipulate pointers to this dynamic array and work with slices of it.
*
* Slices provide a view into a portion of memory without copying data, enabling efficient substring operations.
*
* WARNING: When manipulating memory pointers or slices, make sure to follow the Solidity documentation
* guidelines for https://docs.soliditylang.org/en/v0.8.20/assembly.html#memory-safety[Memory Safety].
*/
library Memory {
type Pointer is bytes32;
/// @dev Returns a `Pointer` to the current free `Pointer`.
function getFreeMemoryPointer() internal pure returns (Pointer ptr) {
assembly ("memory-safe") {
ptr := mload(0x40)
}
}
/**
* @dev Sets the free `Pointer` to a specific value.
*
* WARNING: Everything after the pointer may be overwritten.
**/
function setFreeMemoryPointer(Pointer ptr) internal pure {
assembly ("memory-safe") {
mstore(0x40, ptr)
}
}
/// @dev `Pointer` to `bytes32`. Expects a pointer to a properly ABI-encoded `bytes` object.
function asBytes32(Pointer ptr) internal pure returns (bytes32) {
return Pointer.unwrap(ptr);
}
/// @dev `bytes32` to `Pointer`. Expects a pointer to a properly ABI-encoded `bytes` object.
function asPointer(bytes32 value) internal pure returns (Pointer) {
return Pointer.wrap(value);
}
/// @dev Move a pointer forward by a given offset.
function forward(Pointer ptr, uint256 offset) internal pure returns (Pointer) {
return Pointer.wrap(bytes32(uint256(Pointer.unwrap(ptr)) + offset));
}
/// @dev Equality comparator for memory pointers.
function equal(Pointer ptr1, Pointer ptr2) internal pure returns (bool) {
return Pointer.unwrap(ptr1) == Pointer.unwrap(ptr2);
}
type Slice is bytes32;
/// @dev Get a slice representation of a bytes object in memory
function asSlice(bytes memory self) internal pure returns (Slice result) {
assembly ("memory-safe") {
result := or(shl(128, mload(self)), add(self, 0x20))
}
}
/// @dev Returns the length of a given slice (equiv to self.length for calldata slices)
function length(Slice self) internal pure returns (uint256 result) {
assembly ("memory-safe") {
result := shr(128, self)
}
}
/// @dev Offset a memory slice (equivalent to self[start:] for calldata slices)
function slice(Slice self, uint256 offset) internal pure returns (Slice) {
if (offset > length(self)) Panic.panic(Panic.ARRAY_OUT_OF_BOUNDS);
return _asSlice(length(self) - offset, forward(_pointer(self), offset));
}
/// @dev Offset and cut a Slice (equivalent to self[start:start+length] for calldata slices)
function slice(Slice self, uint256 offset, uint256 len) internal pure returns (Slice) {
if (offset + len > length(self)) Panic.panic(Panic.ARRAY_OUT_OF_BOUNDS);
return _asSlice(len, forward(_pointer(self), offset));
}
/**
* @dev Read a bytes32 buffer from a given Slice at a specific offset
*
* NOTE: If offset > length(slice) - 0x20, part of the return value will be out of bound of the slice. These bytes are zeroed.
*/
function load(Slice self, uint256 offset) internal pure returns (bytes32 value) {
uint256 outOfBoundBytes = Math.saturatingSub(0x20 + offset, length(self));
if (outOfBoundBytes > 0x1f) Panic.panic(Panic.ARRAY_OUT_OF_BOUNDS);
assembly ("memory-safe") {
value := and(mload(add(and(self, shr(128, not(0))), offset)), shl(mul(8, outOfBoundBytes), not(0)))
}
}
/// @dev Extract the data corresponding to a Slice (allocate new memory)
function toBytes(Slice self) internal pure returns (bytes memory result) {
uint256 len = length(self);
Memory.Pointer ptr = _pointer(self);
assembly ("memory-safe") {
result := mload(0x40)
mstore(result, len)
mcopy(add(result, 0x20), ptr, len)
mstore(0x40, add(add(result, len), 0x20))
}
}
/**
* @dev Private helper: create a slice from raw values (length and pointer)
*
* NOTE: this function MUST NOT be called with `len` or `ptr` that exceed `2**128-1`. This should never be
* the case of slices produced by `asSlice(bytes)`, and function that reduce the scope of slices
* (`slice(Slice,uint256)` and `slice(Slice,uint256, uint256)`) should not cause this issue if the parent slice is
* correct.
*/
function _asSlice(uint256 len, Memory.Pointer ptr) private pure returns (Slice result) {
assembly ("memory-safe") {
result := or(shl(128, len), ptr)
}
}
/// @dev Returns the memory location of a given slice (equiv to self.offset for calldata slices)
function _pointer(Slice self) private pure returns (Memory.Pointer result) {
assembly ("memory-safe") {
result := and(self, shr(128, not(0)))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.5.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Return the 512-bit addition of two uint256.
*
* The result is stored in two 256 variables such that sum = high * 2²⁵⁶ + low.
*/
function add512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
assembly ("memory-safe") {
low := add(a, b)
high := lt(low, a)
}
}
/**
* @dev Return the 512-bit multiplication of two uint256.
*
* The result is stored in two 256 variables such that product = high * 2²⁵⁶ + low.
*/
function mul512(uint256 a, uint256 b) internal pure returns (uint256 high, uint256 low) {
// 512-bit multiply [high low] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
// the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = high * 2²⁵⁶ + low.
assembly ("memory-safe") {
let mm := mulmod(a, b, not(0))
low := mul(a, b)
high := sub(sub(mm, low), lt(mm, low))
}
}
/**
* @dev Returns the addition of two unsigned integers, with a success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
success = c >= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with a success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a - b;
success = c <= a;
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with a success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a * b;
assembly ("memory-safe") {
// Only true when the multiplication doesn't overflow
// (c / a == b) || (a == 0)
success := or(eq(div(c, a), b), iszero(a))
}
// equivalent to: success ? c : 0
result = c * SafeCast.toUint(success);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `DIV` opcode returns zero when the denominator is 0.
result := div(a, b)
}
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
success = b > 0;
assembly ("memory-safe") {
// The `MOD` opcode returns zero when the denominator is 0.
result := mod(a, b)
}
}
}
/**
* @dev Unsigned saturating addition, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingAdd(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryAdd(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Unsigned saturating subtraction, bounds to zero instead of overflowing.
*/
function saturatingSub(uint256 a, uint256 b) internal pure returns (uint256) {
(, uint256 result) = trySub(a, b);
return result;
}
/**
* @dev Unsigned saturating multiplication, bounds to `2²⁵⁶ - 1` instead of overflowing.
*/
function saturatingMul(uint256 a, uint256 b) internal pure returns (uint256) {
(bool success, uint256 result) = tryMul(a, b);
return ternary(success, result, type(uint256).max);
}
/**
* @dev Branchless ternary evaluation for `condition ? a : b`. 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. `condition ? a : b`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * SafeCast.toUint(condition));
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
Panic.panic(Panic.DIVISION_BY_ZERO);
}
// The following calculation ensures accurate ceiling division without overflow.
// Since a is non-zero, (a - 1) / b will not overflow.
// The largest possible result occurs when (a - 1) / b is type(uint256).max,
// but the largest value we can obtain is type(uint256).max - 1, which happens
// when a = type(uint256).max and b = 1.
unchecked {
return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
}
}
/**
* @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
*
* Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
* Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
// Handle non-overflow cases, 256 by 256 division.
if (high == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return low / denominator;
}
// Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
if (denominator <= high) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [high low].
uint256 remainder;
assembly ("memory-safe") {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
high := sub(high, gt(remainder, low))
low := sub(low, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly ("memory-safe") {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [high low] by twos.
low := div(low, twos)
// Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from high into low.
low |= high * twos;
// Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
// that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv ≡ 1 mod 2⁴.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
// works in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2⁸
inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
inverse *= 2 - denominator * inverse; // inverse mod 2³²
inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2²⁵⁶. Since the preconditions guarantee that the outcome is
// less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and high
// is no longer required.
result = low * inverse;
return result;
}
}
/**
* @dev Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
}
/**
* @dev Calculates floor(x * y >> n) with full precision. Throws if result overflows a uint256.
*/
function mulShr(uint256 x, uint256 y, uint8 n) internal pure returns (uint256 result) {
unchecked {
(uint256 high, uint256 low) = mul512(x, y);
if (high >= 1 << n) {
Panic.panic(Panic.UNDER_OVERFLOW);
}
return (high << (256 - n)) | (low >> n);
}
}
/**
* @dev Calculates x * y >> n with full precision, following the selected rounding direction.
*/
function mulShr(uint256 x, uint256 y, uint8 n, Rounding rounding) internal pure returns (uint256) {
return mulShr(x, y, n) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, 1 << n) > 0);
}
/**
* @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
*
* If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
* If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
*
* If the input value is not inversible, 0 is returned.
*
* NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
* inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
*/
function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
unchecked {
if (n == 0) return 0;
// The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
// Used to compute integers x and y such that: ax + ny = gcd(a, n).
// When the gcd is 1, then the inverse of a modulo n exists and it's x.
// ax + ny = 1
// ax = 1 + (-y)n
// ax ≡ 1 (mod n) # x is the inverse of a modulo n
// If the remainder is 0 the gcd is n right away.
uint256 remainder = a % n;
uint256 gcd = n;
// Therefore the initial coefficients are:
// ax + ny = gcd(a, n) = n
// 0a + 1n = n
int256 x = 0;
int256 y = 1;
while (remainder != 0) {
uint256 quotient = gcd / remainder;
(gcd, remainder) = (
// The old remainder is the next gcd to try.
remainder,
// Compute the next remainder.
// Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
// where gcd is at most n (capped to type(uint256).max)
gcd - remainder * quotient
);
(x, y) = (
// Increment the coefficient of a.
y,
// Decrement the coefficient of n.
// Can overflow, but the result is casted to uint256 so that the
// next value of y is "wrapped around" to a value between 0 and n - 1.
x - y * int256(quotient)
);
}
if (gcd != 1) return 0; // No inverse exists.
return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
}
}
/**
* @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
*
* From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
* prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
* `a**(p-2)` is the modular multiplicative inverse of a in Fp.
*
* NOTE: this function does NOT check that `p` is a prime greater than `2`.
*/
function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
unchecked {
return Math.modExp(a, p - 2, p);
}
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
*
* Requirements:
* - modulus can't be zero
* - underlying staticcall to precompile must succeed
*
* IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
* sure the chain you're using it on supports the precompiled contract for modular exponentiation
* at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
* the underlying function will succeed given the lack of a revert, but the result may be incorrectly
* interpreted as 0.
*/
function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
(bool success, uint256 result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
* It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
* to operate modulo 0 or if the underlying precompile reverted.
*
* IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
* you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
* https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
* of a revert, but the result may be incorrectly interpreted as 0.
*/
function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
if (m == 0) return (false, 0);
assembly ("memory-safe") {
let ptr := mload(0x40)
// | Offset | Content | Content (Hex) |
// |-----------|------------|--------------------------------------------------------------------|
// | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x60:0x7f | value of b | 0x<.............................................................b> |
// | 0x80:0x9f | value of e | 0x<.............................................................e> |
// | 0xa0:0xbf | value of m | 0x<.............................................................m> |
mstore(ptr, 0x20)
mstore(add(ptr, 0x20), 0x20)
mstore(add(ptr, 0x40), 0x20)
mstore(add(ptr, 0x60), b)
mstore(add(ptr, 0x80), e)
mstore(add(ptr, 0xa0), m)
// Given the result < m, it's guaranteed to fit in 32 bytes,
// so we can use the memory scratch space located at offset 0.
success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
result := mload(0x00)
}
}
/**
* @dev Variant of {modExp} that supports inputs of arbitrary length.
*/
function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
(bool success, bytes memory result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Variant of {tryModExp} that supports inputs of arbitrary length.
*/
function tryModExp(
bytes memory b,
bytes memory e,
bytes memory m
) internal view returns (bool success, bytes memory result) {
if (_zeroBytes(m)) return (false, new bytes(0));
uint256 mLen = m.length;
// Encode call args in result and move the free memory pointer
result = abi.encodePacked(b.length, e.length, mLen, b, e, m);
assembly ("memory-safe") {
let dataPtr := add(result, 0x20)
// Write result on top of args to avoid allocating extra memory.
success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
// Overwrite the length.
// result.length > returndatasize() is guaranteed because returndatasize() == m.length
mstore(result, mLen)
// Set the memory pointer after the returned data.
mstore(0x40, add(dataPtr, mLen))
}
}
/**
* @dev Returns whether the provided byte array is zero.
*/
function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
for (uint256 i = 0; i < byteArray.length; ++i) {
if (byteArray[i] != 0) {
return false;
}
}
return true;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* This method is based on Newton's method for computing square roots; the algorithm is restricted to only
* using integer operations.
*/
function sqrt(uint256 a) internal pure returns (uint256) {
unchecked {
// Take care of easy edge cases when a == 0 or a == 1
if (a <= 1) {
return a;
}
// In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
// sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
// the current value as `ε_n = | x_n - sqrt(a) |`.
//
// For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
// of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
// bigger than any uint256.
//
// By noticing that
// `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
// we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
// to the msb function.
uint256 aa = a;
uint256 xn = 1;
if (aa >= (1 << 128)) {
aa >>= 128;
xn <<= 64;
}
if (aa >= (1 << 64)) {
aa >>= 64;
xn <<= 32;
}
if (aa >= (1 << 32)) {
aa >>= 32;
xn <<= 16;
}
if (aa >= (1 << 16)) {
aa >>= 16;
xn <<= 8;
}
if (aa >= (1 << 8)) {
aa >>= 8;
xn <<= 4;
}
if (aa >= (1 << 4)) {
aa >>= 4;
xn <<= 2;
}
if (aa >= (1 << 2)) {
xn <<= 1;
}
// We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
//
// We can refine our estimation by noticing that the middle of that interval minimizes the error.
// If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
// This is going to be our x_0 (and ε_0)
xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)
// From here, Newton's method give us:
// x_{n+1} = (x_n + a / x_n) / 2
//
// One should note that:
// x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
// = ((x_n² + a) / (2 * x_n))² - a
// = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
// = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
// = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
// = (x_n² - a)² / (2 * x_n)²
// = ((x_n² - a) / (2 * x_n))²
// ≥ 0
// Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
//
// This gives us the proof of quadratic convergence of the sequence:
// ε_{n+1} = | x_{n+1} - sqrt(a) |
// = | (x_n + a / x_n) / 2 - sqrt(a) |
// = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
// = | (x_n - sqrt(a))² / (2 * x_n) |
// = | ε_n² / (2 * x_n) |
// = ε_n² / | (2 * x_n) |
//
// For the first iteration, we have a special case where x_0 is known:
// ε_1 = ε_0² / | (2 * x_0) |
// ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
// ≤ 2**(2*e-4) / (3 * 2**(e-1))
// ≤ 2**(e-3) / 3
// ≤ 2**(e-3-log2(3))
// ≤ 2**(e-4.5)
//
// For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
// ε_{n+1} = ε_n² / | (2 * x_n) |
// ≤ (2**(e-k))² / (2 * 2**(e-1))
// ≤ 2**(2*e-2*k) / 2**e
// ≤ 2**(e-2*k)
xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above
xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5
xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9
xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18
xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36
xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72
// Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
// ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
// sqrt(a) or sqrt(a) + 1.
return xn - SafeCast.toUint(xn > a / xn);
}
}
/**
* @dev Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// If upper 8 bits of 16-bit half set, add 8 to result
r |= SafeCast.toUint((x >> r) > 0xff) << 3;
// If upper 4 bits of 8-bit half set, add 4 to result
r |= SafeCast.toUint((x >> r) > 0xf) << 2;
// Shifts value right by the current result and use it as an index into this lookup table:
//
// | x (4 bits) | index | table[index] = MSB position |
// |------------|---------|-----------------------------|
// | 0000 | 0 | table[0] = 0 |
// | 0001 | 1 | table[1] = 0 |
// | 0010 | 2 | table[2] = 1 |
// | 0011 | 3 | table[3] = 1 |
// | 0100 | 4 | table[4] = 2 |
// | 0101 | 5 | table[5] = 2 |
// | 0110 | 6 | table[6] = 2 |
// | 0111 | 7 | table[7] = 2 |
// | 1000 | 8 | table[8] = 3 |
// | 1001 | 9 | table[9] = 3 |
// | 1010 | 10 | table[10] = 3 |
// | 1011 | 11 | table[11] = 3 |
// | 1100 | 12 | table[12] = 3 |
// | 1101 | 13 | table[13] = 3 |
// | 1110 | 14 | table[14] = 3 |
// | 1111 | 15 | table[15] = 3 |
//
// The lookup table is represented as a 32-byte value with the MSB positions for 0-15 in the last 16 bytes.
assembly ("memory-safe") {
r := or(r, byte(shr(r, x), 0x0000010102020202030303030303030300000000000000000000000000000000))
}
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 x) internal pure returns (uint256 r) {
// If value has upper 128 bits set, log2 result is at least 128
r = SafeCast.toUint(x > 0xffffffffffffffffffffffffffffffff) << 7;
// If upper 64 bits of 128-bit half set, add 64 to result
r |= SafeCast.toUint((x >> r) > 0xffffffffffffffff) << 6;
// If upper 32 bits of 64-bit half set, add 32 to result
r |= SafeCast.toUint((x >> r) > 0xffffffff) << 5;
// If upper 16 bits of 32-bit half set, add 16 to result
r |= SafeCast.toUint((x >> r) > 0xffff) << 4;
// Add 1 if upper 8 bits of 16-bit half set, and divide accumulated result by 8
return (r >> 3) | SafeCast.toUint((x >> r) > 0xff);
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
/**
* @dev Counts the number of leading zero bits in a uint256.
*/
function clz(uint256 x) internal pure returns (uint256) {
return ternary(x == 0, 256, 255 - log2(x));
}
}// 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.5.0) (utils/Strings.sol)
pragma solidity ^0.8.24;
import {Math} from "./math/Math.sol";
import {SafeCast} from "./math/SafeCast.sol";
import {SignedMath} from "./math/SignedMath.sol";
import {Bytes} from "./Bytes.sol";
/**
* @dev String operations.
*/
library Strings {
using SafeCast for *;
bytes16 private constant HEX_DIGITS = "0123456789abcdef";
uint8 private constant ADDRESS_LENGTH = 20;
uint256 private constant SPECIAL_CHARS_LOOKUP =
(1 << 0x08) | // backspace
(1 << 0x09) | // tab
(1 << 0x0a) | // newline
(1 << 0x0c) | // form feed
(1 << 0x0d) | // carriage return
(1 << 0x22) | // double quote
(1 << 0x5c); // backslash
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @dev The string being parsed contains characters that are not in scope of the given base.
*/
error StringsInvalidChar();
/**
* @dev The string being parsed is not a properly formatted address.
*/
error StringsInvalidAddressFormat();
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
assembly ("memory-safe") {
ptr := add(add(buffer, 0x20), length)
}
while (true) {
ptr--;
assembly ("memory-safe") {
mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toStringSigned(int256 value) internal pure returns (string memory) {
return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
uint256 localValue = value;
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = HEX_DIGITS[localValue & 0xf];
localValue >>= 4;
}
if (localValue != 0) {
revert StringsInsufficientHexLength(value, length);
}
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
* representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
* representation, according to EIP-55.
*/
function toChecksumHexString(address addr) internal pure returns (string memory) {
bytes memory buffer = bytes(toHexString(addr));
// hash the hex part of buffer (skip length + 2 bytes, length 40)
uint256 hashValue;
assembly ("memory-safe") {
hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
}
for (uint256 i = 41; i > 1; --i) {
// possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
// case shift by xoring with 0x20
buffer[i] ^= 0x20;
}
hashValue >>= 4;
}
return string(buffer);
}
/**
* @dev Converts a `bytes` buffer to its ASCII `string` hexadecimal representation.
*/
function toHexString(bytes memory input) internal pure returns (string memory) {
unchecked {
bytes memory buffer = new bytes(2 * input.length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 0; i < input.length; ++i) {
uint8 v = uint8(input[i]);
buffer[2 * i + 2] = HEX_DIGITS[v >> 4];
buffer[2 * i + 3] = HEX_DIGITS[v & 0xf];
}
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.equal(bytes(a), bytes(b));
}
/**
* @dev Parse a decimal string and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input) internal pure returns (uint256) {
return parseUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
uint256 result = 0;
for (uint256 i = begin; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 9) return (false, 0);
result *= 10;
result += chr;
}
return (true, result);
}
/**
* @dev Parse a decimal string and returns the value as a `int256`.
*
* Requirements:
* - The string must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input) internal pure returns (int256) {
return parseInt(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseInt-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input, uint256 begin, uint256 end) internal pure returns (int256) {
(bool success, int256 value) = tryParseInt(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseInt-string} that returns false if the parsing fails because of an invalid character or if
* the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(string memory input) internal pure returns (bool success, int256 value) {
return _tryParseIntUncheckedBounds(input, 0, bytes(input).length);
}
uint256 private constant ABS_MIN_INT256 = 2 ** 255;
/**
* @dev Variant of {parseInt-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character or if the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, int256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseIntUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseInt-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseIntUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, int256 value) {
bytes memory buffer = bytes(input);
// Check presence of a negative sign.
bytes1 sign = begin == end ? bytes1(0) : bytes1(_unsafeReadBytesOffset(buffer, begin)); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
bool positiveSign = sign == bytes1("+");
bool negativeSign = sign == bytes1("-");
uint256 offset = (positiveSign || negativeSign).toUint();
(bool absSuccess, uint256 absValue) = tryParseUint(input, begin + offset, end);
if (absSuccess && absValue < ABS_MIN_INT256) {
return (true, negativeSign ? -int256(absValue) : int256(absValue));
} else if (absSuccess && negativeSign && absValue == ABS_MIN_INT256) {
return (true, type(int256).min);
} else return (false, 0);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input) internal pure returns (uint256) {
return parseHexUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseHexUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseHexUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseHexUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint-string-uint256-uint256} that returns false if the parsing fails because of an
* invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseHexUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseHexUint-string-uint256-uint256} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseHexUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
// skip 0x prefix if present
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(buffer, begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 offset = hasPrefix.toUint() * 2;
uint256 result = 0;
for (uint256 i = begin + offset; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 15) return (false, 0);
result *= 16;
unchecked {
// Multiplying by 16 is equivalent to a shift of 4 bits (with additional overflow check).
// This guarantees that adding a value < 16 will not cause an overflow, hence the unchecked.
result += chr;
}
}
return (true, result);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as an `address`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input) internal pure returns (address) {
return parseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input, uint256 begin, uint256 end) internal pure returns (address) {
(bool success, address value) = tryParseAddress(input, begin, end);
if (!success) revert StringsInvalidAddressFormat();
return value;
}
/**
* @dev Variant of {parseAddress-string} that returns false if the parsing fails because the input is not a properly
* formatted address. See {parseAddress-string} requirements.
*/
function tryParseAddress(string memory input) internal pure returns (bool success, address value) {
return tryParseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress-string-uint256-uint256} that returns false if the parsing fails because input is not a properly
* formatted address. See {parseAddress-string-uint256-uint256} requirements.
*/
function tryParseAddress(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, address value) {
if (end > bytes(input).length || begin > end) return (false, address(0));
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(bytes(input), begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 expectedLength = 40 + hasPrefix.toUint() * 2;
// check that input is the correct length
if (end - begin == expectedLength) {
// length guarantees that this does not overflow, and value is at most type(uint160).max
(bool s, uint256 v) = _tryParseHexUintUncheckedBounds(input, begin, end);
return (s, address(uint160(v)));
} else {
return (false, address(0));
}
}
function _tryParseChr(bytes1 chr) private pure returns (uint8) {
uint8 value = uint8(chr);
// Try to parse `chr`:
// - Case 1: [0-9]
// - Case 2: [a-f]
// - Case 3: [A-F]
// - otherwise not supported
unchecked {
if (value > 47 && value < 58) value -= 48;
else if (value > 96 && value < 103) value -= 87;
else if (value > 64 && value < 71) value -= 55;
else return type(uint8).max;
}
return value;
}
/**
* @dev Escape special characters in JSON strings. This can be useful to prevent JSON injection in NFT metadata.
*
* WARNING: This function should only be used in double quoted JSON strings. Single quotes are not escaped.
*
* NOTE: This function escapes all unicode characters, and not just the ones in ranges defined in section 2.5 of
* RFC-4627 (U+0000 to U+001F, U+0022 and U+005C). ECMAScript's `JSON.parse` does recover escaped unicode
* characters that are not in this range, but other tooling may provide different results.
*/
function escapeJSON(string memory input) internal pure returns (string memory) {
bytes memory buffer = bytes(input);
bytes memory output = new bytes(2 * buffer.length); // worst case scenario
uint256 outputLength = 0;
for (uint256 i = 0; i < buffer.length; ++i) {
bytes1 char = bytes1(_unsafeReadBytesOffset(buffer, i));
if (((SPECIAL_CHARS_LOOKUP & (1 << uint8(char))) != 0)) {
output[outputLength++] = "\\";
if (char == 0x08) output[outputLength++] = "b";
else if (char == 0x09) output[outputLength++] = "t";
else if (char == 0x0a) output[outputLength++] = "n";
else if (char == 0x0c) output[outputLength++] = "f";
else if (char == 0x0d) output[outputLength++] = "r";
else if (char == 0x5c) output[outputLength++] = "\\";
else if (char == 0x22) {
// solhint-disable-next-line quotes
output[outputLength++] = '"';
}
} else {
output[outputLength++] = char;
}
}
// write the actual length and deallocate unused memory
assembly ("memory-safe") {
mstore(output, outputLength)
mstore(0x40, add(output, shl(5, shr(5, add(outputLength, 63)))))
}
return string(output);
}
/**
* @dev Reads a bytes32 from a bytes array without bounds checking.
*
* NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
* assembly block as such would prevent some optimizations.
*/
function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
value := mload(add(add(buffer, 0x20), offset))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC20.sol)
pragma solidity >=0.4.16;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (interfaces/IERC165.sol)
pragma solidity >=0.4.16;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol)
pragma solidity ^0.8.20;
/**
* @dev Helper library for emitting standardized panic codes.
*
* ```solidity
* contract Example {
* using Panic for uint256;
*
* // Use any of the declared internal constants
* function foo() { Panic.GENERIC.panic(); }
*
* // Alternatively
* function foo() { Panic.panic(Panic.GENERIC); }
* }
* ```
*
* Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
*
* _Available since v5.1._
*/
// slither-disable-next-line unused-state
library Panic {
/// @dev generic / unspecified error
uint256 internal constant GENERIC = 0x00;
/// @dev used by the assert() builtin
uint256 internal constant ASSERT = 0x01;
/// @dev arithmetic underflow or overflow
uint256 internal constant UNDER_OVERFLOW = 0x11;
/// @dev division or modulo by zero
uint256 internal constant DIVISION_BY_ZERO = 0x12;
/// @dev enum conversion error
uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
/// @dev invalid encoding in storage
uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
/// @dev empty array pop
uint256 internal constant EMPTY_ARRAY_POP = 0x31;
/// @dev array out of bounds access
uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
/// @dev resource error (too large allocation or too large array)
uint256 internal constant RESOURCE_ERROR = 0x41;
/// @dev calling invalid internal function
uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;
/// @dev Reverts with a panic code. Recommended to use with
/// the internal constants with predefined codes.
function panic(uint256 code) internal pure {
assembly ("memory-safe") {
mstore(0x00, 0x4e487b71)
mstore(0x20, code)
revert(0x1c, 0x24)
}
}
}// 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.5.0) (utils/Bytes.sol)
pragma solidity ^0.8.24;
import {Math} from "./math/Math.sol";
/**
* @dev Bytes operations.
*/
library Bytes {
/**
* @dev Forward search for `s` in `buffer`
* * If `s` is present in the buffer, returns the index of the first instance
* * If `s` is not present in the buffer, returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf[Javascript's `Array.indexOf`]
*/
function indexOf(bytes memory buffer, bytes1 s) internal pure returns (uint256) {
return indexOf(buffer, s, 0);
}
/**
* @dev Forward search for `s` in `buffer` starting at position `pos`
* * If `s` is present in the buffer (at or after `pos`), returns the index of the next instance
* * If `s` is not present in the buffer (at or after `pos`), returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf[Javascript's `Array.indexOf`]
*/
function indexOf(bytes memory buffer, bytes1 s, uint256 pos) internal pure returns (uint256) {
uint256 length = buffer.length;
for (uint256 i = pos; i < length; ++i) {
if (bytes1(_unsafeReadBytesOffset(buffer, i)) == s) {
return i;
}
}
return type(uint256).max;
}
/**
* @dev Backward search for `s` in `buffer`
* * If `s` is present in the buffer, returns the index of the last instance
* * If `s` is not present in the buffer, returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf[Javascript's `Array.lastIndexOf`]
*/
function lastIndexOf(bytes memory buffer, bytes1 s) internal pure returns (uint256) {
return lastIndexOf(buffer, s, type(uint256).max);
}
/**
* @dev Backward search for `s` in `buffer` starting at position `pos`
* * If `s` is present in the buffer (at or before `pos`), returns the index of the previous instance
* * If `s` is not present in the buffer (at or before `pos`), returns type(uint256).max
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/lastIndexOf[Javascript's `Array.lastIndexOf`]
*/
function lastIndexOf(bytes memory buffer, bytes1 s, uint256 pos) internal pure returns (uint256) {
unchecked {
uint256 length = buffer.length;
for (uint256 i = Math.min(Math.saturatingAdd(pos, 1), length); i > 0; --i) {
if (bytes1(_unsafeReadBytesOffset(buffer, i - 1)) == s) {
return i - 1;
}
}
return type(uint256).max;
}
}
/**
* @dev Copies the content of `buffer`, from `start` (included) to the end of `buffer` into a new bytes object in
* memory.
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice[Javascript's `Array.slice`]
*/
function slice(bytes memory buffer, uint256 start) internal pure returns (bytes memory) {
return slice(buffer, start, buffer.length);
}
/**
* @dev Copies the content of `buffer`, from `start` (included) to `end` (excluded) into a new bytes object in
* memory. The `end` argument is truncated to the length of the `buffer`.
*
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/slice[Javascript's `Array.slice`]
*/
function slice(bytes memory buffer, uint256 start, uint256 end) internal pure returns (bytes memory) {
// sanitize
end = Math.min(end, buffer.length);
start = Math.min(start, end);
// allocate and copy
bytes memory result = new bytes(end - start);
assembly ("memory-safe") {
mcopy(add(result, 0x20), add(add(buffer, 0x20), start), sub(end, start))
}
return result;
}
/**
* @dev Moves the content of `buffer`, from `start` (included) to the end of `buffer` to the start of that buffer.
*
* NOTE: This function modifies the provided buffer in place. If you need to preserve the original buffer, use {slice} instead
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice[Javascript's `Array.splice`]
*/
function splice(bytes memory buffer, uint256 start) internal pure returns (bytes memory) {
return splice(buffer, start, buffer.length);
}
/**
* @dev Moves the content of `buffer`, from `start` (included) to end (excluded) to the start of that buffer. The
* `end` argument is truncated to the length of the `buffer`.
*
* NOTE: This function modifies the provided buffer in place. If you need to preserve the original buffer, use {slice} instead
* NOTE: replicates the behavior of https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice[Javascript's `Array.splice`]
*/
function splice(bytes memory buffer, uint256 start, uint256 end) internal pure returns (bytes memory) {
// sanitize
end = Math.min(end, buffer.length);
start = Math.min(start, end);
// allocate and copy
assembly ("memory-safe") {
mcopy(add(buffer, 0x20), add(add(buffer, 0x20), start), sub(end, start))
mstore(buffer, sub(end, start))
}
return buffer;
}
/**
* @dev Concatenate an array of bytes into a single bytes object.
*
* For fixed bytes types, we recommend using the solidity built-in `bytes.concat` or (equivalent)
* `abi.encodePacked`.
*
* NOTE: this could be done in assembly with a single loop that expands starting at the FMP, but that would be
* significantly less readable. It might be worth benchmarking the savings of the full-assembly approach.
*/
function concat(bytes[] memory buffers) internal pure returns (bytes memory) {
uint256 length = 0;
for (uint256 i = 0; i < buffers.length; ++i) {
length += buffers[i].length;
}
bytes memory result = new bytes(length);
uint256 offset = 0x20;
for (uint256 i = 0; i < buffers.length; ++i) {
bytes memory input = buffers[i];
assembly ("memory-safe") {
mcopy(add(result, offset), add(input, 0x20), mload(input))
}
unchecked {
offset += input.length;
}
}
return result;
}
/**
* @dev Returns true if the two byte buffers are equal.
*/
function equal(bytes memory a, bytes memory b) internal pure returns (bool) {
return a.length == b.length && keccak256(a) == keccak256(b);
}
/**
* @dev Reverses the byte order of a bytes32 value, converting between little-endian and big-endian.
* Inspired by https://graphics.stanford.edu/~seander/bithacks.html#ReverseParallel[Reverse Parallel]
*/
function reverseBytes32(bytes32 value) internal pure returns (bytes32) {
value = // swap bytes
((value >> 8) & 0x00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF) |
((value & 0x00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF00FF) << 8);
value = // swap 2-byte long pairs
((value >> 16) & 0x0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF) |
((value & 0x0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF0000FFFF) << 16);
value = // swap 4-byte long pairs
((value >> 32) & 0x00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF) |
((value & 0x00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF00000000FFFFFFFF) << 32);
value = // swap 8-byte long pairs
((value >> 64) & 0x0000000000000000FFFFFFFFFFFFFFFF0000000000000000FFFFFFFFFFFFFFFF) |
((value & 0x0000000000000000FFFFFFFFFFFFFFFF0000000000000000FFFFFFFFFFFFFFFF) << 64);
return (value >> 128) | (value << 128); // swap 16-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 128-bit values.
function reverseBytes16(bytes16 value) internal pure returns (bytes16) {
value = // swap bytes
((value & 0xFF00FF00FF00FF00FF00FF00FF00FF00) >> 8) |
((value & 0x00FF00FF00FF00FF00FF00FF00FF00FF) << 8);
value = // swap 2-byte long pairs
((value & 0xFFFF0000FFFF0000FFFF0000FFFF0000) >> 16) |
((value & 0x0000FFFF0000FFFF0000FFFF0000FFFF) << 16);
value = // swap 4-byte long pairs
((value & 0xFFFFFFFF00000000FFFFFFFF00000000) >> 32) |
((value & 0x00000000FFFFFFFF00000000FFFFFFFF) << 32);
return (value >> 64) | (value << 64); // swap 8-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 64-bit values.
function reverseBytes8(bytes8 value) internal pure returns (bytes8) {
value = ((value & 0xFF00FF00FF00FF00) >> 8) | ((value & 0x00FF00FF00FF00FF) << 8); // swap bytes
value = ((value & 0xFFFF0000FFFF0000) >> 16) | ((value & 0x0000FFFF0000FFFF) << 16); // swap 2-byte long pairs
return (value >> 32) | (value << 32); // swap 4-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 32-bit values.
function reverseBytes4(bytes4 value) internal pure returns (bytes4) {
value = ((value & 0xFF00FF00) >> 8) | ((value & 0x00FF00FF) << 8); // swap bytes
return (value >> 16) | (value << 16); // swap 2-byte long pairs
}
/// @dev Same as {reverseBytes32} but optimized for 16-bit values.
function reverseBytes2(bytes2 value) internal pure returns (bytes2) {
return (value >> 8) | (value << 8);
}
/**
* @dev Counts the number of leading zero bits a bytes array. Returns `8 * buffer.length`
* if the buffer is all zeros.
*/
function clz(bytes memory buffer) internal pure returns (uint256) {
for (uint256 i = 0; i < buffer.length; i += 0x20) {
bytes32 chunk = _unsafeReadBytesOffset(buffer, i);
if (chunk != bytes32(0)) {
return Math.min(8 * i + Math.clz(uint256(chunk)), 8 * buffer.length);
}
}
return 8 * buffer.length;
}
/**
* @dev Reads a bytes32 from a bytes array without bounds checking.
*
* NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
* assembly block as such would prevent some optimizations.
*/
function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
value := mload(add(add(buffer, 0x20), offset))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.4.0) (utils/introspection/IERC165.sol)
pragma solidity >=0.4.16;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/
interface IERC165 {
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[ERC section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/
function supportsInterface(bytes4 interfaceId) external view returns (bool);
}{
"remappings": [
"solady/=lib/solady/src/",
"@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/"
],
"optimizer": {
"enabled": true,
"runs": 200
},
"metadata": {
"useLiteralContent": false,
"bytecodeHash": "ipfs",
"appendCBOR": true
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"evmVersion": "prague",
"viaIR": false
}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":"AssetMismatch","type":"error"},{"inputs":[],"name":"ChildAlreadyHasParent","type":"error"},{"inputs":[],"name":"ChildNotInParent","type":"error"},{"inputs":[],"name":"DeploymentFailed","type":"error"},{"inputs":[{"internalType":"address","name":"implementation","type":"address"}],"name":"ERC1967InvalidImplementation","type":"error"},{"inputs":[],"name":"ERC1967NonPayable","type":"error"},{"inputs":[],"name":"FailedCall","type":"error"},{"inputs":[],"name":"InvalidAccessControl","type":"error"},{"inputs":[],"name":"InvalidAsset","type":"error"},{"inputs":[],"name":"InvalidBeacon","type":"error"},{"inputs":[],"name":"InvalidCategory","type":"error"},{"inputs":[],"name":"InvalidChild","type":"error"},{"inputs":[],"name":"InvalidInitialization","type":"error"},{"inputs":[],"name":"InvalidParent","type":"error"},{"inputs":[],"name":"NotInitializing","type":"error"},{"inputs":[],"name":"ParentAlreadyExists","type":"error"},{"inputs":[],"name":"UUPSUnauthorizedCallContext","type":"error"},{"inputs":[{"internalType":"bytes32","name":"slot","type":"bytes32"}],"name":"UUPSUnsupportedProxiableUUID","type":"error"},{"inputs":[],"name":"Unauthorized","type":"error"},{"inputs":[],"name":"VaultAlreadyExists","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"parent","type":"address"},{"indexed":true,"internalType":"address","name":"child","type":"address"},{"indexed":false,"internalType":"uint256","name":"weight","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"maxAllocation","type":"uint256"}],"name":"ChildAddedToParent","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"parent","type":"address"},{"indexed":true,"internalType":"address","name":"child","type":"address"}],"name":"ChildRemovedFromParent","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint64","name":"version","type":"uint64"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"parentVault","type":"address"},{"indexed":true,"internalType":"address","name":"asset","type":"address"},{"indexed":true,"internalType":"bytes32","name":"category","type":"bytes32"},{"indexed":false,"internalType":"address","name":"deployer","type":"address"},{"indexed":false,"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"ParentVaultDeployed","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"implementation","type":"address"}],"name":"Upgraded","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"vault","type":"address"},{"indexed":true,"internalType":"address","name":"asset","type":"address"},{"indexed":false,"internalType":"address","name":"deployer","type":"address"},{"indexed":false,"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"VaultDeployed","type":"event"},{"inputs":[],"name":"UPGRADE_INTERFACE_VERSION","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"accessControl","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"parent","type":"address"},{"internalType":"address","name":"child","type":"address"},{"internalType":"uint256","name":"weight","type":"uint256"},{"internalType":"uint256","name":"maxAllocation","type":"uint256"}],"name":"addChildToParent","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"beacon","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"asset","type":"address"},{"internalType":"bytes32","name":"category","type":"bytes32"},{"internalType":"string","name":"name","type":"string"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct ICarthaVaultFactory.ParentVaultConfig","name":"config","type":"tuple"}],"name":"deployParentVault","outputs":[{"internalType":"address","name":"parentVault","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"asset","type":"address"},{"internalType":"bytes32","name":"poolId","type":"bytes32"},{"internalType":"string","name":"name","type":"string"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct ICarthaVaultFactory.VaultConfig","name":"config","type":"tuple"}],"name":"deployVault","outputs":[{"internalType":"address","name":"vault","type":"address"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"getAllParents","outputs":[{"internalType":"address[]","name":"parents","type":"address[]"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getAllVaults","outputs":[{"internalType":"address[]","name":"vaults","type":"address[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"parent","type":"address"}],"name":"getChildrenOfParent","outputs":[{"internalType":"address[]","name":"","type":"address[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"vault","type":"address"}],"name":"getDefaultConfig","outputs":[{"components":[{"internalType":"address","name":"asset","type":"address"},{"internalType":"bytes32","name":"poolId","type":"bytes32"},{"internalType":"string","name":"name","type":"string"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct ICarthaVaultFactory.VaultConfig","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes32","name":"category","type":"bytes32"}],"name":"getParentByCategory","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"child","type":"address"}],"name":"getParentOfChild","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getParentVaultCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"getParentVaultInfo","outputs":[{"components":[{"internalType":"address","name":"vaultAddress","type":"address"},{"internalType":"address","name":"asset","type":"address"},{"internalType":"bytes32","name":"category","type":"bytes32"},{"internalType":"uint256","name":"deployedAt","type":"uint256"},{"internalType":"address","name":"deployer","type":"address"}],"internalType":"struct ICarthaVaultFactory.ParentVaultInfo","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getVaultCount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"vaultId","type":"uint256"}],"name":"getVaultInfo","outputs":[{"components":[{"internalType":"address","name":"vaultAddress","type":"address"},{"internalType":"address","name":"asset","type":"address"},{"internalType":"uint256","name":"deployedAt","type":"uint256"},{"internalType":"address","name":"deployer","type":"address"}],"internalType":"struct ICarthaVaultFactory.VaultInfo","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"}],"name":"getVaultsByAsset","outputs":[{"internalType":"address[]","name":"","type":"address[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"beacon_","type":"address"},{"internalType":"address","name":"parentBeacon_","type":"address"},{"internalType":"address","name":"accessControl_","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"vault","type":"address"}],"name":"isFactoryVault","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"vault","type":"address"}],"name":"isParentVault","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"parentBeacon","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"proxiableUUID","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"parent","type":"address"},{"internalType":"address","name":"child","type":"address"}],"name":"removeChildFromParent","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
60a060405230608052348015610013575f5ffd5b5061001c610021565b6100d3565b7ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00805468010000000000000000900460ff16156100715760405163f92ee8a960e01b815260040160405180910390fd5b80546001600160401b03908116146100d05780546001600160401b0319166001600160401b0390811782556040519081527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b50565b608051612a2c6100f95f395f8181611acf01528181611af80152611c2f0152612a2c5ff3fe608060405260043610610147575f3560e01c8063917704f5116100b3578063a61b09b41161006d578063a61b09b4146103c6578063ad3cb1cc146103e5578063b1ba962014610422578063c0c53b8b14610482578063c8a4406e146104a1578063f0519af5146104b5575f5ffd5b8063917704f5146102bf5780639434b454146102de57806397331bf9146103485780639a9912f41461035c5780639e6334521461037b578063a409603e146103a7575f5ffd5b806358c624421161010457806358c624421461022657806359659e901461024557806359d8e793146102595780635a2723291461026d5780636b3106d21461028c57806374d4e491146102ab575f5ffd5b8063108940521461014b57806313007d551461018057806338464e3e146101ac57806344683342146101c05780634f1ef286146101ef57806352d1902d14610204575b5f5ffd5b348015610156575f5ffd5b5061016a610165366004611f18565b6104d4565b6040516101779190611f3a565b60405180910390f35b34801561018b575f5ffd5b50610194610553565b6040516001600160a01b039091168152602001610177565b3480156101b7575f5ffd5b5061019461056e565b3480156101cb575f5ffd5b506101df6101da366004611f18565b610589565b6040519015158152602001610177565b6102026101fd366004611ff1565b6105b6565b005b34801561020f575f5ffd5b506102186105d5565b604051908152602001610177565b348015610231575f5ffd5b506101df610240366004611f18565b6105f0565b348015610250575f5ffd5b5061019461061d565b348015610264575f5ffd5b50610218610635565b348015610278575f5ffd5b50610194610287366004611f18565b610647565b348015610297575f5ffd5b506101946102a6366004612094565b610675565b3480156102b6575f5ffd5b50610218610a6a565b3480156102ca575f5ffd5b506101946102d9366004612094565b610a7c565b3480156102e9575f5ffd5b506102fd6102f83660046120ce565b610e8b565b604051610177919081516001600160a01b0390811682526020808401518216908301526040808401519083015260608084015190830152608092830151169181019190915260a00190565b348015610353575f5ffd5b5061016a610f32565b348015610367575f5ffd5b5061016a610376366004611f18565b610fff565b348015610386575f5ffd5b5061039a610395366004611f18565b61107c565b6040516101779190612113565b3480156103b2575f5ffd5b506102026103c1366004612170565b611262565b3480156103d1575f5ffd5b506101946103e03660046120ce565b611518565b3480156103f0575f5ffd5b50610415604051806040016040528060058152602001640352e302e360dc1b81525081565b60405161017791906121b3565b34801561042d575f5ffd5b5061044161043c3660046120ce565b61153d565b604051610177919081516001600160a01b03908116825260208084015182169083015260408084015190830152606092830151169181019190915260800190565b34801561048d575f5ffd5b5061020261049c3660046121c5565b6115d3565b3480156104ac575f5ffd5b5061016a611783565b3480156104c0575f5ffd5b506102026104cf36600461220d565b61184a565b60606104de611aa0565b6001600160a01b0383165f90815260049190910160209081526040918290208054835181840281018401909452808452909183018282801561054757602002820191905f5260205f20905b81546001600160a01b03168152600190910190602001808311610529575b50505050509050919050565b5f61055c611aa0565b600101546001600160a01b0316919050565b5f610577611aa0565b600601546001600160a01b0316919050565b5f610592611aa0565b6001600160a01b039092165f90815260089290920160205250604090205460ff1690565b6105be611ac4565b6105c782611b54565b6105d18282611b5e565b5050565b5f6105de611c24565b505f5160206129d75f395f51905f5290565b5f6105f9611aa0565b6001600160a01b039092165f90815260039290920160205250604090205460ff1690565b5f610626611aa0565b546001600160a01b0316919050565b5f61063e611aa0565b60070154919050565b5f610650611aa0565b6001600160a01b039283165f908152600b919091016020526040902054909116919050565b5f5f61067f611aa0565b6001810154604051634f4bdc7b60e11b8152600360048201523360248201529192506001600160a01b031690639e97b8f690604401602060405180830381865afa1580156106cf573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906106f39190612244565b15801561076f57506001810154604051634f4bdc7b60e11b81525f60048201523360248201526001600160a01b0390911690639e97b8f690604401602060405180830381865afa158015610749573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061076d9190612244565b155b1561078c576040516282b42960e81b815260040160405180910390fd5b5f61079a6020850185611f18565b6001600160a01b0316036107c157604051636448d6e960e11b815260040160405180910390fd5b60208301356107e357604051636b3ac97b60e11b815260040160405180910390fd5b6020808401355f9081526009830190915260409020546001600160a01b03161561082057604051630631c40160e41b815260040160405180910390fd5b5f634d35069b60e01b6108366020860186611f18565b60208601356108486040880188612263565b61085560608a018a612263565b6001890154604051610879979695949392916001600160a01b0316906024016122d5565b60408051601f198184030181529181526020820180516001600160e01b03166001600160e01b031990941693909317909252600684015491519092506001600160a01b039091169082906108cc90611ef4565b6108d792919061232c565b604051809103905ff0801580156108f0573d5f5f3e3d5ffd5b509250816007016040518060a00160405280856001600160a01b03168152602001865f0160208101906109239190611f18565b6001600160a01b039081168252602088810180358285018190524260408087019190915233606096870152875460018181018a555f998a52858a20895160059093020180549288166001600160a01b0319938416178155898701518183018054918a169185169190911790558984015160028201559789015160038901556080909801516004909701805497871697821697909717909655938a1680885260088a018452848820805460ff19169097179096558087526009890190925291909420805490921690921790556109f89086611f18565b6001600160a01b0316846001600160a01b03167f0a0482cb617dd3bbd9872d24f962c3188011cc532751331c982793010d2a082c3360018760070180549050610a41919061234f565b604080516001600160a01b03909316835260208301919091520160405180910390a45050919050565b5f610a73611aa0565b60020154919050565b5f5f610a86611aa0565b6001810154604051634f4bdc7b60e11b8152600360048201523360248201529192506001600160a01b031690639e97b8f690604401602060405180830381865afa158015610ad6573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610afa9190612244565b158015610b7657506001810154604051634f4bdc7b60e11b81525f60048201523360248201526001600160a01b0390911690639e97b8f690604401602060405180830381865afa158015610b50573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610b749190612244565b155b15610b93576040516282b42960e81b815260040160405180910390fd5b5f610ba16020850185611f18565b6001600160a01b031603610bc857604051636448d6e960e11b815260040160405180910390fd5b6020808401355f9081526005830190915260409020546001600160a01b031615610c05576040516304aabf3360e01b815260040160405180910390fd5b60018101545f90630363b1a360e51b906001600160a01b0316610c2b6020870187611f18565b6020870135610c3d6040890189612263565b610c4a60608b018b612263565b604051602401610c60979695949392919061236e565b60408051601f198184030181529181526020820180516001600160e01b03166001600160e01b031990941693909317909252835491519092506001600160a01b03909116908290610cb090611ef4565b610cbb92919061232c565b604051809103905ff080158015610cd4573d5f5f3e3d5ffd5b509250816002016040518060800160405280856001600160a01b03168152602001865f016020810190610d079190611f18565b6001600160a01b03908116825242602080840191909152336040938401528454600181810187555f9687528287208651600493840290910180549186166001600160a01b0319928316178155878501518184018054918816918416919091179055878701516002820155606090970151600397880180549187169190921617905592891686529387018152918420805460ff191690911790559084019190610db190870187611f18565b6001600160a01b03908116825260208083019390935260409182015f90812080546001810182559082528482200180546001600160a01b031990811693891693841790915588850180358352600588019095529290208054909216179055610e199085611f18565b6001600160a01b0316836001600160a01b03167fc2e5ddea5eacd045870205571e36f82db7a65a2ae56113d5732b0009ffb5b7e23360018660020180549050610e62919061234f565b604080516001600160a01b03909316835260208301919091520160405180910390a35050919050565b6040805160a0810182525f80825260208201819052918101829052606081018290526080810191909152610ebd611aa0565b6007018281548110610ed157610ed16123c2565b5f9182526020918290206040805160a081018252600590930290910180546001600160a01b03908116845260018201548116948401949094526002810154918301919091526003810154606083015260040154909116608082015292915050565b60605f610f3d611aa0565b60028101549091508067ffffffffffffffff811115610f5e57610f5e611f85565b604051908082528060200260200182016040528015610f87578160200160208202803683370190505b5092505f5b81811015610ff957826002018181548110610fa957610fa96123c2565b5f91825260209091206004909102015484516001600160a01b0390911690859083908110610fd957610fd96123c2565b6001600160a01b0390921660209283029190910190910152600101610f8c565b50505090565b6060611009611aa0565b6001600160a01b0383165f908152600a9190910160209081526040918290208054835181840281018401909452808452909183018282801561054757602002820191905f5260205f209081546001600160a01b031681526001909101906020018083116105295750505050509050919050565b6110ae60405180608001604052805f6001600160a01b031681526020015f815260200160608152602001606081525090565b5f8290506040518060800160405280826001600160a01b03166338d52e0f6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156110f9573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061111d91906123d6565b6001600160a01b03168152602001826001600160a01b0316633e0dc34e6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611167573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061118b91906123f1565b8152602001846001600160a01b03166306fdde036040518163ffffffff1660e01b81526004015f60405180830381865afa1580156111cb573d5f5f3e3d5ffd5b505050506040513d5f823e601f3d908101601f191682016040526111f29190810190612408565b8152602001846001600160a01b03166395d89b416040518163ffffffff1660e01b81526004015f60405180830381865afa158015611232573d5f5f3e3d5ffd5b505050506040513d5f823e601f3d908101601f191682016040526112599190810190612408565b90529392505050565b5f61126c81611c6d565b5f611275611aa0565b6001600160a01b0387165f90815260088201602052604090205490915060ff166112b257604051630bea7bb360e31b815260040160405180910390fd5b6001600160a01b0385165f90815260038201602052604090205460ff166112ec5760405163bfb8ddef60e01b815260040160405180910390fd5b6001600160a01b038581165f908152600b83016020526040902054161561132657604051637019140b60e01b815260040160405180910390fd5b846001600160a01b03166338d52e0f6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611362573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061138691906123d6565b6001600160a01b0316866001600160a01b03166338d52e0f6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156113cb573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906113ef91906123d6565b6001600160a01b031614611416576040516341e0808560e11b815260040160405180910390fd5b6001600160a01b038681165f818152600a84016020908152604080832080546001810182559084528284200180546001600160a01b0319908116968c16968717909155858452600b87019092529182902080549091168317905551630be66bf760e11b815260048101929092526024820186905260448201859052906317ccd7ee906064015f604051808303815f87803b1580156114b2575f5ffd5b505af11580156114c4573d5f5f3e3d5ffd5b505060408051878152602081018790526001600160a01b03808a1694508a1692507f81ccd7f10ecf926b1df8c96525fee94c0b2c7f35f3cddbe88edb75aab89d5538910160405180910390a3505050505050565b5f611521611aa0565b5f9283526009016020525060409020546001600160a01b031690565b604080516080810182525f808252602082018190529181018290526060810191909152611568611aa0565b600201828154811061157c5761157c6123c2565b5f91825260209182902060408051608081018252600490930290910180546001600160a01b039081168452600182015481169484019490945260028101549183019190915260030154909116606082015292915050565b5f6115dc611d08565b805490915060ff600160401b820416159067ffffffffffffffff165f811580156116035750825b90505f8267ffffffffffffffff16600114801561161f5750303b155b90508115801561162d575080155b1561164b5760405163f92ee8a960e01b815260040160405180910390fd5b845467ffffffffffffffff19166001178555831561167557845460ff60401b1916600160401b1785555b6001600160a01b03881661169c576040516330740e7560e01b815260040160405180910390fd5b6001600160a01b0387166116c3576040516330740e7560e01b815260040160405180910390fd5b6001600160a01b0386166116ea57604051636b7a4e2f60e01b815260040160405180910390fd5b5f6116f3611aa0565b80546001600160a01b03808c166001600160a01b03199283161783556006830180548c831690841617905560019092018054928a169290911691909117905550831561177957845460ff60401b19168555604051600181527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b5050505050505050565b60605f61178e611aa0565b60078101549091508067ffffffffffffffff8111156117af576117af611f85565b6040519080825280602002602001820160405280156117d8578160200160208202803683370190505b5092505f5b81811015610ff9578260070181815481106117fa576117fa6123c2565b5f91825260209091206005909102015484516001600160a01b039091169085908390811061182a5761182a6123c2565b6001600160a01b03909216602092830291909101909101526001016117dd565b5f61185481611c6d565b5f61185d611aa0565b6001600160a01b0385165f90815260088201602052604090205490915060ff1661189a57604051630bea7bb360e31b815260040160405180910390fd5b6001600160a01b038381165f908152600b830160205260409020548116908516146118d857604051631c08230b60e31b815260040160405180910390fd5b6001600160a01b0384165f908152600a820160205260408120905b81548110156119e657846001600160a01b0316828281548110611918576119186123c2565b5f918252602090912001546001600160a01b0316036119de57815482906119419060019061234f565b81548110611951576119516123c2565b905f5260205f20015f9054906101000a90046001600160a01b031682828154811061197e5761197e6123c2565b905f5260205f20015f6101000a8154816001600160a01b0302191690836001600160a01b03160217905550818054806119b9576119b961247d565b5f8281526020902081015f1990810180546001600160a01b03191690550190556119e6565b6001016118f3565b506001600160a01b038481165f818152600b8501602052604080822080546001600160a01b0319169055516368f4471560e11b8152600481019290925260248201529086169063d1e88e2a906044015f604051808303815f87803b158015611a4c575f5ffd5b505af1158015611a5e573d5f5f3e3d5ffd5b50506040516001600160a01b038088169350881691507faa364c5a43f622438394e39bb19ae01ed1ece4b5612ede769aaff39f2eaec86c905f90a35050505050565b7fdb1962c4a5690592ca7465b77ca9c0256f84cb63342b7979f63bc5799a61d10090565b306001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000161480611b3457507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316611b28611d32565b6001600160a01b031614155b15611b525760405163703e46dd60e11b815260040160405180910390fd5b565b5f6105d181611c6d565b816001600160a01b03166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa925050508015611bb8575060408051601f3d908101601f19168201909252611bb5918101906123f1565b60015b611be557604051634c9c8ce360e01b81526001600160a01b03831660048201526024015b60405180910390fd5b5f5160206129d75f395f51905f528114611c1557604051632a87526960e21b815260048101829052602401611bdc565b611c1f8383611d46565b505050565b306001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001614611b525760405163703e46dd60e11b815260040160405180910390fd5b5f611c76611aa0565b6001810154604051634f4bdc7b60e11b815260ff851660048201523360248201529192506001600160a01b031690639e97b8f690604401602060405180830381865afa158015611cc8573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190611cec9190612244565b6105d1576040516282b42960e81b815260040160405180910390fd5b5f807ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005b92915050565b5f5f5160206129d75f395f51905f52610626565b611d4f82611d9b565b6040516001600160a01b038316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a2805115611d9357611c1f8282611dfe565b6105d1611e9e565b806001600160a01b03163b5f03611dd057604051634c9c8ce360e01b81526001600160a01b0382166004820152602401611bdc565b5f5160206129d75f395f51905f5280546001600160a01b0319166001600160a01b0392909216919091179055565b60605f611e0b8484611ebd565b9050808015611e2c57505f3d1180611e2c57505f846001600160a01b03163b115b15611e4157611e39611ed0565b915050611d2c565b8015611e6b57604051639996b31560e01b81526001600160a01b0385166004820152602401611bdc565b3d15611e7e57611e79611ee9565b611e97565b60405163d6bda27560e01b815260040160405180910390fd5b5092915050565b3415611b525760405163b398979f60e01b815260040160405180910390fd5b5f5f5f835160208501865af49392505050565b6040513d81523d5f602083013e3d602001810160405290565b6040513d5f823e3d81fd5b6105458061249283390190565b6001600160a01b0381168114611f15575f5ffd5b50565b5f60208284031215611f28575f5ffd5b8135611f3381611f01565b9392505050565b602080825282518282018190525f918401906040840190835b81811015611f7a5783516001600160a01b0316835260209384019390920191600101611f53565b509095945050505050565b634e487b7160e01b5f52604160045260245ffd5b604051601f8201601f1916810167ffffffffffffffff81118282101715611fc257611fc2611f85565b604052919050565b5f67ffffffffffffffff821115611fe357611fe3611f85565b50601f01601f191660200190565b5f5f60408385031215612002575f5ffd5b823561200d81611f01565b9150602083013567ffffffffffffffff811115612028575f5ffd5b8301601f81018513612038575f5ffd5b803561204b61204682611fca565b611f99565b81815286602083850101111561205f575f5ffd5b816020840160208301375f602083830101528093505050509250929050565b5f6080828403121561208e575f5ffd5b50919050565b5f602082840312156120a4575f5ffd5b813567ffffffffffffffff8111156120ba575f5ffd5b6120c68482850161207e565b949350505050565b5f602082840312156120de575f5ffd5b5035919050565b5f81518084528060208401602086015e5f602082860101526020601f19601f83011685010191505092915050565b6020815260018060a01b038251166020820152602082015160408201525f60408301516080606084015261214a60a08401826120e5565b90506060840151601f1984830301608085015261216782826120e5565b95945050505050565b5f5f5f5f60808587031215612183575f5ffd5b843561218e81611f01565b9350602085013561219e81611f01565b93969395505050506040820135916060013590565b602081525f611f3360208301846120e5565b5f5f5f606084860312156121d7575f5ffd5b83356121e281611f01565b925060208401356121f281611f01565b9150604084013561220281611f01565b809150509250925092565b5f5f6040838503121561221e575f5ffd5b823561222981611f01565b9150602083013561223981611f01565b809150509250929050565b5f60208284031215612254575f5ffd5b81518015158114611f33575f5ffd5b5f5f8335601e19843603018112612278575f5ffd5b83018035915067ffffffffffffffff821115612292575f5ffd5b6020019150368190038213156122a6575f5ffd5b9250929050565b81835281816020850137505f828201602090810191909152601f909101601f19169091010190565b60018060a01b038816815286602082015260a060408201525f6122fc60a0830187896122ad565b828103606084015261230f8186886122ad565b91505060018060a01b038316608083015298975050505050505050565b6001600160a01b03831681526040602082018190525f906120c6908301846120e5565b81810381811115611d2c57634e487b7160e01b5f52601160045260245ffd5b6001600160a01b038881168252871660208201526040810186905260a0606082018190525f906123a190830186886122ad565b82810360808401526123b48185876122ad565b9a9950505050505050505050565b634e487b7160e01b5f52603260045260245ffd5b5f602082840312156123e6575f5ffd5b8151611f3381611f01565b5f60208284031215612401575f5ffd5b5051919050565b5f60208284031215612418575f5ffd5b815167ffffffffffffffff81111561242e575f5ffd5b8201601f8101841361243e575f5ffd5b805161244c61204682611fca565b818152856020838501011115612460575f5ffd5b8160208401602083015e5f91810160200191909152949350505050565b634e487b7160e01b5f52603160045260245ffdfe60a060405260405161054538038061054583398101604081905261002291610331565b61002c828261003e565b506001600160a01b0316608052610413565b610047826100fb565b6040516001600160a01b038316907f1cf3b03a6cf19fa2baba4df148e9dcabedea7f8a5c07840e207e5c089be95d3e905f90a28051156100ef576100ea826001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156100c0573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906100e491906103f3565b82610209565b505050565b6100f76102aa565b5050565b806001600160a01b03163b5f0361013557604051631933b43b60e21b81526001600160a01b03821660048201526024015b60405180910390fd5b807fa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d5080546001600160a01b0319166001600160a01b0392831617905560408051635c60da1b60e01b815290515f92841691635c60da1b9160048083019260209291908290030181865afa1580156101ae573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906101d291906103f3565b9050806001600160a01b03163b5f036100f757604051634c9c8ce360e01b81526001600160a01b038216600482015260240161012c565b60605f61021684846102cb565b905080801561023757505f3d118061023757505f846001600160a01b03163b115b1561024c576102446102de565b9150506102a4565b801561027657604051639996b31560e01b81526001600160a01b038516600482015260240161012c565b3d15610289576102846102f7565b6102a2565b60405163d6bda27560e01b815260040160405180910390fd5b505b92915050565b34156102c95760405163b398979f60e01b815260040160405180910390fd5b565b5f5f5f835160208501865af49392505050565b6040513d81523d5f602083013e3d602001810160405290565b6040513d5f823e3d81fd5b80516001600160a01b0381168114610318575f5ffd5b919050565b634e487b7160e01b5f52604160045260245ffd5b5f5f60408385031215610342575f5ffd5b61034b83610302565b60208401519092506001600160401b03811115610366575f5ffd5b8301601f81018513610376575f5ffd5b80516001600160401b0381111561038f5761038f61031d565b604051601f8201601f19908116603f011681016001600160401b03811182821017156103bd576103bd61031d565b6040528181528282016020018710156103d4575f5ffd5b8160208401602083015e5f602083830101528093505050509250929050565b5f60208284031215610403575f5ffd5b61040c82610302565b9392505050565b60805161011b61042a5f395f601d015261011b5ff3fe6080604052600a600c565b005b60186014601a565b609d565b565b5f7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156076573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906098919060ba565b905090565b365f5f375f5f365f845af43d5f5f3e80801560b6573d5ff35b3d5ffd5b5f6020828403121560c9575f5ffd5b81516001600160a01b038116811460de575f5ffd5b939250505056fea26469706673582212209feaae96ef527d4a6734c541184509556af07ec95e549668e999b98bdc8b10c164736f6c634300081e0033360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbca26469706673582212206f5f35c5dd63d4c36a4f5fcdc35f5d4f73e265b497ab6969405bd47f986366c564736f6c634300081e0033
Deployed Bytecode
0x608060405260043610610147575f3560e01c8063917704f5116100b3578063a61b09b41161006d578063a61b09b4146103c6578063ad3cb1cc146103e5578063b1ba962014610422578063c0c53b8b14610482578063c8a4406e146104a1578063f0519af5146104b5575f5ffd5b8063917704f5146102bf5780639434b454146102de57806397331bf9146103485780639a9912f41461035c5780639e6334521461037b578063a409603e146103a7575f5ffd5b806358c624421161010457806358c624421461022657806359659e901461024557806359d8e793146102595780635a2723291461026d5780636b3106d21461028c57806374d4e491146102ab575f5ffd5b8063108940521461014b57806313007d551461018057806338464e3e146101ac57806344683342146101c05780634f1ef286146101ef57806352d1902d14610204575b5f5ffd5b348015610156575f5ffd5b5061016a610165366004611f18565b6104d4565b6040516101779190611f3a565b60405180910390f35b34801561018b575f5ffd5b50610194610553565b6040516001600160a01b039091168152602001610177565b3480156101b7575f5ffd5b5061019461056e565b3480156101cb575f5ffd5b506101df6101da366004611f18565b610589565b6040519015158152602001610177565b6102026101fd366004611ff1565b6105b6565b005b34801561020f575f5ffd5b506102186105d5565b604051908152602001610177565b348015610231575f5ffd5b506101df610240366004611f18565b6105f0565b348015610250575f5ffd5b5061019461061d565b348015610264575f5ffd5b50610218610635565b348015610278575f5ffd5b50610194610287366004611f18565b610647565b348015610297575f5ffd5b506101946102a6366004612094565b610675565b3480156102b6575f5ffd5b50610218610a6a565b3480156102ca575f5ffd5b506101946102d9366004612094565b610a7c565b3480156102e9575f5ffd5b506102fd6102f83660046120ce565b610e8b565b604051610177919081516001600160a01b0390811682526020808401518216908301526040808401519083015260608084015190830152608092830151169181019190915260a00190565b348015610353575f5ffd5b5061016a610f32565b348015610367575f5ffd5b5061016a610376366004611f18565b610fff565b348015610386575f5ffd5b5061039a610395366004611f18565b61107c565b6040516101779190612113565b3480156103b2575f5ffd5b506102026103c1366004612170565b611262565b3480156103d1575f5ffd5b506101946103e03660046120ce565b611518565b3480156103f0575f5ffd5b50610415604051806040016040528060058152602001640352e302e360dc1b81525081565b60405161017791906121b3565b34801561042d575f5ffd5b5061044161043c3660046120ce565b61153d565b604051610177919081516001600160a01b03908116825260208084015182169083015260408084015190830152606092830151169181019190915260800190565b34801561048d575f5ffd5b5061020261049c3660046121c5565b6115d3565b3480156104ac575f5ffd5b5061016a611783565b3480156104c0575f5ffd5b506102026104cf36600461220d565b61184a565b60606104de611aa0565b6001600160a01b0383165f90815260049190910160209081526040918290208054835181840281018401909452808452909183018282801561054757602002820191905f5260205f20905b81546001600160a01b03168152600190910190602001808311610529575b50505050509050919050565b5f61055c611aa0565b600101546001600160a01b0316919050565b5f610577611aa0565b600601546001600160a01b0316919050565b5f610592611aa0565b6001600160a01b039092165f90815260089290920160205250604090205460ff1690565b6105be611ac4565b6105c782611b54565b6105d18282611b5e565b5050565b5f6105de611c24565b505f5160206129d75f395f51905f5290565b5f6105f9611aa0565b6001600160a01b039092165f90815260039290920160205250604090205460ff1690565b5f610626611aa0565b546001600160a01b0316919050565b5f61063e611aa0565b60070154919050565b5f610650611aa0565b6001600160a01b039283165f908152600b919091016020526040902054909116919050565b5f5f61067f611aa0565b6001810154604051634f4bdc7b60e11b8152600360048201523360248201529192506001600160a01b031690639e97b8f690604401602060405180830381865afa1580156106cf573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906106f39190612244565b15801561076f57506001810154604051634f4bdc7b60e11b81525f60048201523360248201526001600160a01b0390911690639e97b8f690604401602060405180830381865afa158015610749573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061076d9190612244565b155b1561078c576040516282b42960e81b815260040160405180910390fd5b5f61079a6020850185611f18565b6001600160a01b0316036107c157604051636448d6e960e11b815260040160405180910390fd5b60208301356107e357604051636b3ac97b60e11b815260040160405180910390fd5b6020808401355f9081526009830190915260409020546001600160a01b03161561082057604051630631c40160e41b815260040160405180910390fd5b5f634d35069b60e01b6108366020860186611f18565b60208601356108486040880188612263565b61085560608a018a612263565b6001890154604051610879979695949392916001600160a01b0316906024016122d5565b60408051601f198184030181529181526020820180516001600160e01b03166001600160e01b031990941693909317909252600684015491519092506001600160a01b039091169082906108cc90611ef4565b6108d792919061232c565b604051809103905ff0801580156108f0573d5f5f3e3d5ffd5b509250816007016040518060a00160405280856001600160a01b03168152602001865f0160208101906109239190611f18565b6001600160a01b039081168252602088810180358285018190524260408087019190915233606096870152875460018181018a555f998a52858a20895160059093020180549288166001600160a01b0319938416178155898701518183018054918a169185169190911790558984015160028201559789015160038901556080909801516004909701805497871697821697909717909655938a1680885260088a018452848820805460ff19169097179096558087526009890190925291909420805490921690921790556109f89086611f18565b6001600160a01b0316846001600160a01b03167f0a0482cb617dd3bbd9872d24f962c3188011cc532751331c982793010d2a082c3360018760070180549050610a41919061234f565b604080516001600160a01b03909316835260208301919091520160405180910390a45050919050565b5f610a73611aa0565b60020154919050565b5f5f610a86611aa0565b6001810154604051634f4bdc7b60e11b8152600360048201523360248201529192506001600160a01b031690639e97b8f690604401602060405180830381865afa158015610ad6573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610afa9190612244565b158015610b7657506001810154604051634f4bdc7b60e11b81525f60048201523360248201526001600160a01b0390911690639e97b8f690604401602060405180830381865afa158015610b50573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190610b749190612244565b155b15610b93576040516282b42960e81b815260040160405180910390fd5b5f610ba16020850185611f18565b6001600160a01b031603610bc857604051636448d6e960e11b815260040160405180910390fd5b6020808401355f9081526005830190915260409020546001600160a01b031615610c05576040516304aabf3360e01b815260040160405180910390fd5b60018101545f90630363b1a360e51b906001600160a01b0316610c2b6020870187611f18565b6020870135610c3d6040890189612263565b610c4a60608b018b612263565b604051602401610c60979695949392919061236e565b60408051601f198184030181529181526020820180516001600160e01b03166001600160e01b031990941693909317909252835491519092506001600160a01b03909116908290610cb090611ef4565b610cbb92919061232c565b604051809103905ff080158015610cd4573d5f5f3e3d5ffd5b509250816002016040518060800160405280856001600160a01b03168152602001865f016020810190610d079190611f18565b6001600160a01b03908116825242602080840191909152336040938401528454600181810187555f9687528287208651600493840290910180549186166001600160a01b0319928316178155878501518184018054918816918416919091179055878701516002820155606090970151600397880180549187169190921617905592891686529387018152918420805460ff191690911790559084019190610db190870187611f18565b6001600160a01b03908116825260208083019390935260409182015f90812080546001810182559082528482200180546001600160a01b031990811693891693841790915588850180358352600588019095529290208054909216179055610e199085611f18565b6001600160a01b0316836001600160a01b03167fc2e5ddea5eacd045870205571e36f82db7a65a2ae56113d5732b0009ffb5b7e23360018660020180549050610e62919061234f565b604080516001600160a01b03909316835260208301919091520160405180910390a35050919050565b6040805160a0810182525f80825260208201819052918101829052606081018290526080810191909152610ebd611aa0565b6007018281548110610ed157610ed16123c2565b5f9182526020918290206040805160a081018252600590930290910180546001600160a01b03908116845260018201548116948401949094526002810154918301919091526003810154606083015260040154909116608082015292915050565b60605f610f3d611aa0565b60028101549091508067ffffffffffffffff811115610f5e57610f5e611f85565b604051908082528060200260200182016040528015610f87578160200160208202803683370190505b5092505f5b81811015610ff957826002018181548110610fa957610fa96123c2565b5f91825260209091206004909102015484516001600160a01b0390911690859083908110610fd957610fd96123c2565b6001600160a01b0390921660209283029190910190910152600101610f8c565b50505090565b6060611009611aa0565b6001600160a01b0383165f908152600a9190910160209081526040918290208054835181840281018401909452808452909183018282801561054757602002820191905f5260205f209081546001600160a01b031681526001909101906020018083116105295750505050509050919050565b6110ae60405180608001604052805f6001600160a01b031681526020015f815260200160608152602001606081525090565b5f8290506040518060800160405280826001600160a01b03166338d52e0f6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156110f9573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061111d91906123d6565b6001600160a01b03168152602001826001600160a01b0316633e0dc34e6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611167573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061118b91906123f1565b8152602001846001600160a01b03166306fdde036040518163ffffffff1660e01b81526004015f60405180830381865afa1580156111cb573d5f5f3e3d5ffd5b505050506040513d5f823e601f3d908101601f191682016040526111f29190810190612408565b8152602001846001600160a01b03166395d89b416040518163ffffffff1660e01b81526004015f60405180830381865afa158015611232573d5f5f3e3d5ffd5b505050506040513d5f823e601f3d908101601f191682016040526112599190810190612408565b90529392505050565b5f61126c81611c6d565b5f611275611aa0565b6001600160a01b0387165f90815260088201602052604090205490915060ff166112b257604051630bea7bb360e31b815260040160405180910390fd5b6001600160a01b0385165f90815260038201602052604090205460ff166112ec5760405163bfb8ddef60e01b815260040160405180910390fd5b6001600160a01b038581165f908152600b83016020526040902054161561132657604051637019140b60e01b815260040160405180910390fd5b846001600160a01b03166338d52e0f6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611362573d5f5f3e3d5ffd5b505050506040513d601f19601f8201168201806040525081019061138691906123d6565b6001600160a01b0316866001600160a01b03166338d52e0f6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156113cb573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906113ef91906123d6565b6001600160a01b031614611416576040516341e0808560e11b815260040160405180910390fd5b6001600160a01b038681165f818152600a84016020908152604080832080546001810182559084528284200180546001600160a01b0319908116968c16968717909155858452600b87019092529182902080549091168317905551630be66bf760e11b815260048101929092526024820186905260448201859052906317ccd7ee906064015f604051808303815f87803b1580156114b2575f5ffd5b505af11580156114c4573d5f5f3e3d5ffd5b505060408051878152602081018790526001600160a01b03808a1694508a1692507f81ccd7f10ecf926b1df8c96525fee94c0b2c7f35f3cddbe88edb75aab89d5538910160405180910390a3505050505050565b5f611521611aa0565b5f9283526009016020525060409020546001600160a01b031690565b604080516080810182525f808252602082018190529181018290526060810191909152611568611aa0565b600201828154811061157c5761157c6123c2565b5f91825260209182902060408051608081018252600490930290910180546001600160a01b039081168452600182015481169484019490945260028101549183019190915260030154909116606082015292915050565b5f6115dc611d08565b805490915060ff600160401b820416159067ffffffffffffffff165f811580156116035750825b90505f8267ffffffffffffffff16600114801561161f5750303b155b90508115801561162d575080155b1561164b5760405163f92ee8a960e01b815260040160405180910390fd5b845467ffffffffffffffff19166001178555831561167557845460ff60401b1916600160401b1785555b6001600160a01b03881661169c576040516330740e7560e01b815260040160405180910390fd5b6001600160a01b0387166116c3576040516330740e7560e01b815260040160405180910390fd5b6001600160a01b0386166116ea57604051636b7a4e2f60e01b815260040160405180910390fd5b5f6116f3611aa0565b80546001600160a01b03808c166001600160a01b03199283161783556006830180548c831690841617905560019092018054928a169290911691909117905550831561177957845460ff60401b19168555604051600181527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d29060200160405180910390a15b5050505050505050565b60605f61178e611aa0565b60078101549091508067ffffffffffffffff8111156117af576117af611f85565b6040519080825280602002602001820160405280156117d8578160200160208202803683370190505b5092505f5b81811015610ff9578260070181815481106117fa576117fa6123c2565b5f91825260209091206005909102015484516001600160a01b039091169085908390811061182a5761182a6123c2565b6001600160a01b03909216602092830291909101909101526001016117dd565b5f61185481611c6d565b5f61185d611aa0565b6001600160a01b0385165f90815260088201602052604090205490915060ff1661189a57604051630bea7bb360e31b815260040160405180910390fd5b6001600160a01b038381165f908152600b830160205260409020548116908516146118d857604051631c08230b60e31b815260040160405180910390fd5b6001600160a01b0384165f908152600a820160205260408120905b81548110156119e657846001600160a01b0316828281548110611918576119186123c2565b5f918252602090912001546001600160a01b0316036119de57815482906119419060019061234f565b81548110611951576119516123c2565b905f5260205f20015f9054906101000a90046001600160a01b031682828154811061197e5761197e6123c2565b905f5260205f20015f6101000a8154816001600160a01b0302191690836001600160a01b03160217905550818054806119b9576119b961247d565b5f8281526020902081015f1990810180546001600160a01b03191690550190556119e6565b6001016118f3565b506001600160a01b038481165f818152600b8501602052604080822080546001600160a01b0319169055516368f4471560e11b8152600481019290925260248201529086169063d1e88e2a906044015f604051808303815f87803b158015611a4c575f5ffd5b505af1158015611a5e573d5f5f3e3d5ffd5b50506040516001600160a01b038088169350881691507faa364c5a43f622438394e39bb19ae01ed1ece4b5612ede769aaff39f2eaec86c905f90a35050505050565b7fdb1962c4a5690592ca7465b77ca9c0256f84cb63342b7979f63bc5799a61d10090565b306001600160a01b037f000000000000000000000000bf24ab3b0b1ea071f5b5f7b0827eeee78ad1a86d161480611b3457507f000000000000000000000000bf24ab3b0b1ea071f5b5f7b0827eeee78ad1a86d6001600160a01b0316611b28611d32565b6001600160a01b031614155b15611b525760405163703e46dd60e11b815260040160405180910390fd5b565b5f6105d181611c6d565b816001600160a01b03166352d1902d6040518163ffffffff1660e01b8152600401602060405180830381865afa925050508015611bb8575060408051601f3d908101601f19168201909252611bb5918101906123f1565b60015b611be557604051634c9c8ce360e01b81526001600160a01b03831660048201526024015b60405180910390fd5b5f5160206129d75f395f51905f528114611c1557604051632a87526960e21b815260048101829052602401611bdc565b611c1f8383611d46565b505050565b306001600160a01b037f000000000000000000000000bf24ab3b0b1ea071f5b5f7b0827eeee78ad1a86d1614611b525760405163703e46dd60e11b815260040160405180910390fd5b5f611c76611aa0565b6001810154604051634f4bdc7b60e11b815260ff851660048201523360248201529192506001600160a01b031690639e97b8f690604401602060405180830381865afa158015611cc8573d5f5f3e3d5ffd5b505050506040513d601f19601f82011682018060405250810190611cec9190612244565b6105d1576040516282b42960e81b815260040160405180910390fd5b5f807ff0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a005b92915050565b5f5f5160206129d75f395f51905f52610626565b611d4f82611d9b565b6040516001600160a01b038316907fbc7cd75a20ee27fd9adebab32041f755214dbc6bffa90cc0225b39da2e5c2d3b905f90a2805115611d9357611c1f8282611dfe565b6105d1611e9e565b806001600160a01b03163b5f03611dd057604051634c9c8ce360e01b81526001600160a01b0382166004820152602401611bdc565b5f5160206129d75f395f51905f5280546001600160a01b0319166001600160a01b0392909216919091179055565b60605f611e0b8484611ebd565b9050808015611e2c57505f3d1180611e2c57505f846001600160a01b03163b115b15611e4157611e39611ed0565b915050611d2c565b8015611e6b57604051639996b31560e01b81526001600160a01b0385166004820152602401611bdc565b3d15611e7e57611e79611ee9565b611e97565b60405163d6bda27560e01b815260040160405180910390fd5b5092915050565b3415611b525760405163b398979f60e01b815260040160405180910390fd5b5f5f5f835160208501865af49392505050565b6040513d81523d5f602083013e3d602001810160405290565b6040513d5f823e3d81fd5b6105458061249283390190565b6001600160a01b0381168114611f15575f5ffd5b50565b5f60208284031215611f28575f5ffd5b8135611f3381611f01565b9392505050565b602080825282518282018190525f918401906040840190835b81811015611f7a5783516001600160a01b0316835260209384019390920191600101611f53565b509095945050505050565b634e487b7160e01b5f52604160045260245ffd5b604051601f8201601f1916810167ffffffffffffffff81118282101715611fc257611fc2611f85565b604052919050565b5f67ffffffffffffffff821115611fe357611fe3611f85565b50601f01601f191660200190565b5f5f60408385031215612002575f5ffd5b823561200d81611f01565b9150602083013567ffffffffffffffff811115612028575f5ffd5b8301601f81018513612038575f5ffd5b803561204b61204682611fca565b611f99565b81815286602083850101111561205f575f5ffd5b816020840160208301375f602083830101528093505050509250929050565b5f6080828403121561208e575f5ffd5b50919050565b5f602082840312156120a4575f5ffd5b813567ffffffffffffffff8111156120ba575f5ffd5b6120c68482850161207e565b949350505050565b5f602082840312156120de575f5ffd5b5035919050565b5f81518084528060208401602086015e5f602082860101526020601f19601f83011685010191505092915050565b6020815260018060a01b038251166020820152602082015160408201525f60408301516080606084015261214a60a08401826120e5565b90506060840151601f1984830301608085015261216782826120e5565b95945050505050565b5f5f5f5f60808587031215612183575f5ffd5b843561218e81611f01565b9350602085013561219e81611f01565b93969395505050506040820135916060013590565b602081525f611f3360208301846120e5565b5f5f5f606084860312156121d7575f5ffd5b83356121e281611f01565b925060208401356121f281611f01565b9150604084013561220281611f01565b809150509250925092565b5f5f6040838503121561221e575f5ffd5b823561222981611f01565b9150602083013561223981611f01565b809150509250929050565b5f60208284031215612254575f5ffd5b81518015158114611f33575f5ffd5b5f5f8335601e19843603018112612278575f5ffd5b83018035915067ffffffffffffffff821115612292575f5ffd5b6020019150368190038213156122a6575f5ffd5b9250929050565b81835281816020850137505f828201602090810191909152601f909101601f19169091010190565b60018060a01b038816815286602082015260a060408201525f6122fc60a0830187896122ad565b828103606084015261230f8186886122ad565b91505060018060a01b038316608083015298975050505050505050565b6001600160a01b03831681526040602082018190525f906120c6908301846120e5565b81810381811115611d2c57634e487b7160e01b5f52601160045260245ffd5b6001600160a01b038881168252871660208201526040810186905260a0606082018190525f906123a190830186886122ad565b82810360808401526123b48185876122ad565b9a9950505050505050505050565b634e487b7160e01b5f52603260045260245ffd5b5f602082840312156123e6575f5ffd5b8151611f3381611f01565b5f60208284031215612401575f5ffd5b5051919050565b5f60208284031215612418575f5ffd5b815167ffffffffffffffff81111561242e575f5ffd5b8201601f8101841361243e575f5ffd5b805161244c61204682611fca565b818152856020838501011115612460575f5ffd5b8160208401602083015e5f91810160200191909152949350505050565b634e487b7160e01b5f52603160045260245ffdfe60a060405260405161054538038061054583398101604081905261002291610331565b61002c828261003e565b506001600160a01b0316608052610413565b610047826100fb565b6040516001600160a01b038316907f1cf3b03a6cf19fa2baba4df148e9dcabedea7f8a5c07840e207e5c089be95d3e905f90a28051156100ef576100ea826001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156100c0573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906100e491906103f3565b82610209565b505050565b6100f76102aa565b5050565b806001600160a01b03163b5f0361013557604051631933b43b60e21b81526001600160a01b03821660048201526024015b60405180910390fd5b807fa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d5080546001600160a01b0319166001600160a01b0392831617905560408051635c60da1b60e01b815290515f92841691635c60da1b9160048083019260209291908290030181865afa1580156101ae573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906101d291906103f3565b9050806001600160a01b03163b5f036100f757604051634c9c8ce360e01b81526001600160a01b038216600482015260240161012c565b60605f61021684846102cb565b905080801561023757505f3d118061023757505f846001600160a01b03163b115b1561024c576102446102de565b9150506102a4565b801561027657604051639996b31560e01b81526001600160a01b038516600482015260240161012c565b3d15610289576102846102f7565b6102a2565b60405163d6bda27560e01b815260040160405180910390fd5b505b92915050565b34156102c95760405163b398979f60e01b815260040160405180910390fd5b565b5f5f5f835160208501865af49392505050565b6040513d81523d5f602083013e3d602001810160405290565b6040513d5f823e3d81fd5b80516001600160a01b0381168114610318575f5ffd5b919050565b634e487b7160e01b5f52604160045260245ffd5b5f5f60408385031215610342575f5ffd5b61034b83610302565b60208401519092506001600160401b03811115610366575f5ffd5b8301601f81018513610376575f5ffd5b80516001600160401b0381111561038f5761038f61031d565b604051601f8201601f19908116603f011681016001600160401b03811182821017156103bd576103bd61031d565b6040528181528282016020018710156103d4575f5ffd5b8160208401602083015e5f602083830101528093505050509250929050565b5f60208284031215610403575f5ffd5b61040c82610302565b9392505050565b60805161011b61042a5f395f601d015261011b5ff3fe6080604052600a600c565b005b60186014601a565b609d565b565b5f7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316635c60da1b6040518163ffffffff1660e01b8152600401602060405180830381865afa1580156076573d5f5f3e3d5ffd5b505050506040513d601f19601f820116820180604052508101906098919060ba565b905090565b365f5f375f5f365f845af43d5f5f3e80801560b6573d5ff35b3d5ffd5b5f6020828403121560c9575f5ffd5b81516001600160a01b038116811460de575f5ffd5b939250505056fea26469706673582212209feaae96ef527d4a6734c541184509556af07ec95e549668e999b98bdc8b10c164736f6c634300081e0033360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbca26469706673582212206f5f35c5dd63d4c36a4f5fcdc35f5d4f73e265b497ab6969405bd47f986366c564736f6c634300081e0033
Loading...
Loading
Loading...
Loading
Loading...
Loading
Net Worth in USD
$0.00
Net Worth in ETH
0
Multichain Portfolio | 32 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.