Source Code
Overview
HYPE Balance
0 HYPEHYPE Value
$0.00View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Cross-Chain Transactions
Loading...
Loading
Contract Name:
HyperVaultRouter
Compiler Version
v0.8.28+commit.7893614a
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.28;
import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import {Ownable2StepUpgradeable} from "@openzeppelin-contracts-upgradeable/access/Ownable2StepUpgradeable.sol";
import {ReentrancyGuardUpgradeable} from "@openzeppelin-contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
import {FixedPointMathLib as FpMath} from "@solmate/utils/FixedPointMathLib.sol";
import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
import {BlueberryErrors as Errors} from "@blueberry-v2/helpers/BlueberryErrors.sol";
import {WrappedVaultShare} from "@blueberry-v2/vaults/hyperliquid/WrappedVaultShare.sol";
import {HyperliquidEscrow} from "@blueberry-v2/vaults/hyperliquid/HyperliquidEscrow.sol";
import {IHyperVaultRouter} from "@blueberry-v2/vaults/hyperliquid/interfaces/IHyperVaultRouter.sol";
import {IHyperliquidEscrow} from "@blueberry-v2/vaults/hyperliquid/interfaces/IHyperliquidEscrow.sol";
/**
* @title HyperVaultRouter
* @author Blueberry
* @notice A vault router contract that coordinates deposits of assets into escrow contracts and handles minting and burning of share tokens
*/
contract HyperVaultRouter is IHyperVaultRouter, Ownable2StepUpgradeable, ReentrancyGuardUpgradeable {
using EnumerableSet for EnumerableSet.UintSet;
using SafeERC20 for IERC20;
using FpMath for uint256;
/*//////////////////////////////////////////////////////////////
Storage
//////////////////////////////////////////////////////////////*/
/// @custom:storage-location erc7201:hypervault.router.v1.storage
struct V1Storage {
/// @notice The last time the fees were accrued
uint64 lastFeeCollectionTimestamp;
/// @notice The management fee in basis points
uint64 managementFeeBps;
/// @notice The minimum value in USD that can be deposited into the vault scaled to 1e18
uint256 minDepositValue;
/// @notice The asset that will be used to withdraw from the vault
address withdrawAsset;
/// @notice An array of addresses of escrow contracts for the vault
address[] escrows;
/// @notice Mapping of asset addresses to their indexes
mapping(address => uint64) assetIndexes;
/// @notice Mapping of asset indexes to their details
mapping(uint64 => AssetDetails) assetDetails;
// @notice Mapping of supported assets
EnumerableSet.UintSet supportedAssets;
/// @notice The address of the fee recipient
address feeRecipient;
/// @notice True if USDC is a supported asset
bool usdcSupported;
}
/*//////////////////////////////////////////////////////////////
Constants & Immutables
//////////////////////////////////////////////////////////////*/
/*==== Hyperliquid Precompiles ====*/
/// @notice Precompile for querying spot market information
address constant SPOT_INFO_PRECOMPILE_ADDRESS = 0x000000000000000000000000000000000000080b;
/// @notice Precompile for querying token information
address constant TOKEN_INFO_PRECOMPILE_ADDRESS = 0x000000000000000000000000000000000000080C;
/*==== USDC Spot Index Constant ====*/
/// @notice The evm & spot index for USDC
uint64 public constant USDC_EVM_SPOT_INDEX = 0;
/*==== General Constants & Immutables ====*/
/// @notice The address of the share token for the vault
address public immutable SHARE_TOKEN;
/// @notice The max numerator for fees
uint256 public constant MAX_FEE_NUMERATOR = 1500;
/// @notice The denominator for the performance fee
uint256 public constant BPS_DENOMINATOR = 10000;
/// @notice The number of seconds in a year
uint256 public constant ONE_YEAR = 360 days;
/*==== Storage Locations ====*/
/// @notice The location for the vault storage
bytes32 public constant V1_HYPERVAULT_ROUTER_STORAGE_LOCATION =
keccak256(abi.encode(uint256(keccak256(bytes("hypervault.router.v1.storage"))) - 1)) & ~bytes32(uint256(0xff));
/*//////////////////////////////////////////////////////////////
Constructor & Initializer
//////////////////////////////////////////////////////////////*/
constructor(address shareToken_) {
require(shareToken_ != address(0), Errors.ADDRESS_ZERO());
SHARE_TOKEN = shareToken_;
_disableInitializers();
}
function initialize(address[] memory escrows_, uint64 minDeposit_, address owner_) public initializer {
require(owner_ != address(0), Errors.ADDRESS_ZERO());
// Keep escrow length small to avoid gas issues
require(escrows_.length <= 5, Errors.INVALID_ESCROW_COUNT());
V1Storage storage $ = _getV1Storage();
$.minDepositValue = minDeposit_;
$.feeRecipient = owner_; // Initial fee recipient is the owner
$.escrows = escrows_;
$.managementFeeBps = 150; // Initial management fee is 1.5%
// Initialize all parent contracts
__Ownable2Step_init();
__ReentrancyGuard_init();
_transferOwnership(owner_);
}
/*///////////////////////////////////////////////////////////////
External Functions
/////////////////////////////////////////////////////////////*/
/// @inheritdoc IHyperVaultRouter
function deposit(address asset, uint256 amount, uint256 minOut)
external
override
nonReentrant
returns (uint256 shares)
{
V1Storage storage $ = _getV1Storage();
// Get the escrow to deposit into
// This will also be used to calculate the USD value of the asset as all escrows have built in spot oracles
HyperliquidEscrow escrow = HyperliquidEscrow($.escrows[depositEscrowIndex()]);
uint64 assetIndex_ = $.assetIndexes[asset];
require(_isAssetSupported($, assetIndex_), Errors.COLLATERAL_NOT_SUPPORTED());
AssetDetails memory details = $.assetDetails[assetIndex_];
require(details.evmContract == asset, Errors.INVALID_EVM_ADDRESS());
// Get the USD value of the asset to properly calculate shares to mint
uint256 scaler = 10 ** (18 - details.evmDecimals);
uint256 rate = _getRate(address(escrow), assetIndex_, details);
uint256 usdValue = rate.mulWadDown(amount * scaler);
require(usdValue >= $.minDepositValue, Errors.MIN_DEPOSIT_AMOUNT());
if (_shareSupply() == 0) {
shares = usdValue;
$.lastFeeCollectionTimestamp = uint64(block.timestamp);
} else {
uint256 tvl_ = tvl();
_takeFee($, tvl_);
shares = usdValue.mulDivDown(_shareSupply(), tvl_);
require(shares > 0, Errors.ZERO_SHARES());
}
require(shares >= minOut, Errors.SLIPPAGE_TOO_HIGH());
emit Deposit(msg.sender, asset, amount, shares);
// Transfer the asset to the escrow contract and mint shares to user
IERC20(asset).safeTransferFrom(msg.sender, address(escrow), amount);
WrappedVaultShare(SHARE_TOKEN).mint(msg.sender, shares);
}
/// @inheritdoc IHyperVaultRouter
function redeem(uint256 shares, uint256 minOut) external override nonReentrant returns (uint256 amount) {
V1Storage storage $ = _getV1Storage();
require(shares > 0, Errors.ZERO_SHARES());
require($.withdrawAsset != address(0), Errors.ADDRESS_ZERO());
uint256 tvl_ = tvl();
_takeFee($, tvl_);
uint256 usdAmount = shares.mulDivDown(tvl_, _shareSupply());
// Get amount of withdraw asset from escrow
uint64 assetIndex_ = $.assetIndexes[$.withdrawAsset];
AssetDetails memory details = $.assetDetails[assetIndex_];
// Convert the USD amount to withdraw to the withdraw asset amount
HyperliquidEscrow escrow = HyperliquidEscrow($.escrows[depositEscrowIndex()]);
uint256 scaler = 10 ** (18 - details.evmDecimals);
uint256 rate = _getRate(address(escrow), assetIndex_, details);
amount = usdAmount.divWadDown(rate * scaler);
require(amount > 0, Errors.AMOUNT_ZERO());
require(amount >= minOut, Errors.SLIPPAGE_TOO_HIGH());
emit Redeem(msg.sender, shares, amount);
// Burn the shares from the user and transfer the withdraw asset to the user
WrappedVaultShare(SHARE_TOKEN).burnFrom(msg.sender, shares);
_transferAssetsToUser($, amount);
}
/// @inheritdoc IHyperVaultRouter
function tvl() public view override returns (uint256 tvl_) {
V1Storage storage $ = _getV1Storage();
uint256 len = $.escrows.length;
for (uint256 i = 0; i < len; i++) {
tvl_ += HyperliquidEscrow($.escrows[i]).tvl();
}
}
/// @inheritdoc IHyperVaultRouter
function depositEscrowIndex() public view override returns (uint256) {
uint256 len = _getV1Storage().escrows.length;
if (len == 1) {
return 0;
}
return (block.timestamp / 2 days) % len;
}
/**
* @notice External function to poke the fee taker
* @dev This function will be executed by the wrapped share token before transferring shares
* but can be executed by anyone.
*/
function pokeFees() external nonReentrant {
V1Storage storage $ = _getV1Storage();
uint256 tvl_ = tvl();
if (tvl_ == 0) {
$.lastFeeCollectionTimestamp = uint64(block.timestamp);
return;
}
_takeFee($, tvl_);
}
/*//////////////////////////////////////////////////////////////
Admin Functions
//////////////////////////////////////////////////////////////*/
/// @notice Sets the management fee in basis points
function setManagementFeeBps(uint64 newManagementFeeBps_) external onlyOwner {
require(newManagementFeeBps_ < MAX_FEE_NUMERATOR, Errors.FEE_TOO_HIGH());
V1Storage storage $ = _getV1Storage();
if ($.lastFeeCollectionTimestamp != 0) {
_takeFee($, tvl());
}
_getV1Storage().managementFeeBps = newManagementFeeBps_;
}
/// @notice Sets the minimum deposit amount for the vault
function setMinDepositValue(uint256 newMinDepositValue_) external onlyOwner {
_getV1Storage().minDepositValue = newMinDepositValue_;
}
/// @notice Sets the fee recipient for the vault
function setFeeRecipient(address newFeeRecipient_) external onlyOwner {
require(newFeeRecipient_ != address(0), Errors.INVALID_FEE_RECIPIENT());
_getV1Storage().feeRecipient = newFeeRecipient_;
}
/// @notice Adds a new supported asset to all the escrows
function addAsset(address assetAddr, uint32 assetIndex_, uint32 spotMarket) external onlyOwner {
V1Storage storage $ = _getV1Storage();
_takeFee($, tvl());
TokenInfo memory info = _getTokenInfo(assetIndex_);
require(info.evmContract == assetAddr, Errors.INVALID_EVM_ADDRESS());
if (assetIndex_ == USDC_EVM_SPOT_INDEX) {
$.usdcSupported = true;
} else {
require(_validateSpotMarket(assetIndex_, spotMarket), Errors.INVALID_SPOT_MARKET());
}
// Calculate the evm Decimals using the evmExtraWeiDecimals returned from the tokenInfo
uint8 evmDecimals = uint8(int8(info.weiDecimals) + info.evmExtraWeiDecimals);
AssetDetails memory details = AssetDetails({
evmContract: info.evmContract,
szDecimals: info.szDecimals,
weiDecimals: info.weiDecimals,
evmDecimals: evmDecimals,
spotMarket: spotMarket
});
// Add the asset to storage
$.assetIndexes[assetAddr] = assetIndex_;
$.assetDetails[assetIndex_] = details;
$.supportedAssets.add(assetIndex_);
// Iterate through all the escrows to add supported assets
uint256 len = $.escrows.length;
for (uint256 i = 0; i < len; ++i) {
HyperliquidEscrow($.escrows[i]).addAsset(assetIndex_, details);
}
emit AssetAdded(assetIndex_, details);
}
/// @notice Removes a supported asset from all the escrows
function removeAsset(address asset) external onlyOwner {
V1Storage storage $ = _getV1Storage();
uint64 assetIndex_ = $.assetIndexes[asset];
// Withdraw asset cannot be set to address(0) once it is set
require(asset != $.withdrawAsset, Errors.INVALID_OPERATION());
// Validate that the address is properly supported
require($.assetDetails[assetIndex_].evmContract == asset, Errors.COLLATERAL_NOT_SUPPORTED());
if (assetIndex_ == USDC_EVM_SPOT_INDEX) $.usdcSupported = false;
delete $.assetIndexes[asset];
delete $.assetDetails[assetIndex_];
$.supportedAssets.remove(assetIndex_);
uint256 len = $.escrows.length;
for (uint256 i = 0; i < len; ++i) {
HyperliquidEscrow($.escrows[i]).removeAsset(assetIndex_);
}
emit AssetRemoved(assetIndex_);
}
/// @notice Sets the withdraw asset for the vault
function setWithdrawAsset(address asset) external onlyOwner {
V1Storage storage $ = _getV1Storage();
uint64 assetIndex_ = $.assetIndexes[asset];
AssetDetails memory details = $.assetDetails[assetIndex_];
require(_isAssetSupported($, assetIndex_), Errors.COLLATERAL_NOT_SUPPORTED());
require(details.evmContract == asset, Errors.INVALID_EVM_ADDRESS());
$.withdrawAsset = asset;
emit WithdrawAssetUpdated(assetIndex_);
}
/*//////////////////////////////////////////////////////////////
Internal Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Returns the rate for a specific asset scaled to 1e18
* @param escrow Address of the escrow contract
* @param assetIndex_ Spot index of the asset
* @param details Asset details struct containing the asset's information
* @return The rate for the asset scaled to 1e18
*/
function _getRate(address escrow, uint256 assetIndex_, AssetDetails memory details)
internal
view
returns (uint256)
{
HyperliquidEscrow escrow_ = HyperliquidEscrow(escrow);
return (assetIndex_ == USDC_EVM_SPOT_INDEX) ? 1e18 : escrow_.getRate(details.spotMarket, details.szDecimals);
}
/**
* @notice Transfers the withdraw asset from the escrows to the user
* @param $ The storage pointer to the v1 vault storage
* @param amount The amount of withdraw asset to transfer
*/
function _transferAssetsToUser(V1Storage storage $, uint256 amount) private {
uint256 remaining = amount;
uint256 len = $.escrows.length;
// Iterate through the escrows and withdraw until the desired amount is reached
for (uint256 i = 0; i < len; ++i) {
address currentEscrow = $.escrows[i];
uint256 escrowBalance = IERC20($.withdrawAsset).balanceOf(currentEscrow);
uint256 transferAmount = Math.min(remaining, escrowBalance);
if (transferAmount > 0) {
// Transfer the withdraw asset from the escrow to the user
HyperliquidEscrow(currentEscrow).transferFunds($.withdrawAsset, msg.sender, transferAmount);
remaining -= transferAmount;
}
if (remaining == 0) break;
}
// If there is still an amount left, revert
require(remaining == 0, Errors.FETCH_ASSETS_FAILED());
}
/**
* @notice Takes the management fee from the vault
* @dev There is a 0.015% annual management fee on the vault's total assets.
* @param grossAssets The total value of the vault
*/
function _takeFee(V1Storage storage $, uint256 grossAssets) private {
uint256 sharesToMint = _previewFeeShares($, grossAssets);
// Even if 0 fees are collected we should still mark as the last collection time to avoid future overcharging
$.lastFeeCollectionTimestamp = uint64(block.timestamp);
if (sharesToMint > 0) {
WrappedVaultShare(SHARE_TOKEN).mint($.feeRecipient, sharesToMint);
}
}
/**
* @notice Returns the total supply of the share tokens
* @return The total supply of the share tokens
*/
function _shareSupply() internal view returns (uint256) {
return IERC20(SHARE_TOKEN).totalSupply();
}
/**
* @notice Internal helper function to calculate the amount of shares that will be minted for the fee collector
* @param $ The storage pointer to the v1 vault storage
* @param tvl_ The total value of the vault
* @return feeShares_ The amount of shares that will be minted for the fee collector
*/
function _previewFeeShares(V1Storage storage $, uint256 tvl_) internal view returns (uint256) {
uint256 expectedFee = _calculateFee($, tvl_);
// In the event of both EXTREME vault inactivity & high fees we need to make sure the fee doesnt underflow
if (expectedFee >= tvl_) {
expectedFee = tvl_ / 2;
}
return expectedFee.mulDivUp(_shareSupply(), tvl_ - expectedFee);
}
/**
* @notice Calculates the management fee based on time elapsed since last collection
* @param $ The storage pointer to the v1 vault storage
* @param grossAssets The total value of the vault
* @return feeAmount_ The amount of fees to take
*/
function _calculateFee(V1Storage storage $, uint256 grossAssets) internal view returns (uint256 feeAmount_) {
if (grossAssets == 0 || block.timestamp <= $.lastFeeCollectionTimestamp) {
return 0;
}
// Calculate time elapsed since last fee collection
uint256 timeElapsed = block.timestamp - $.lastFeeCollectionTimestamp;
// Calculate the pro-rated management fee based on time elapsed
feeAmount_ = (grossAssets * $.managementFeeBps * timeElapsed) / BPS_DENOMINATOR / ONE_YEAR;
return feeAmount_;
}
/**
* @notice Returns whether an asset is supported by the vault
* @param $ The storage pointer to the v1 vault storage
* @param assetIndex_ The asset index to check
* @return Whether the asset is supported
*/
function _isAssetSupported(V1Storage storage $, uint64 assetIndex_) internal view returns (bool) {
if (assetIndex_ == USDC_EVM_SPOT_INDEX) return $.usdcSupported;
return $.supportedAssets.contains(assetIndex_);
}
/**
* @notice Retrieves the token info for a specific asset via Hyperliquid Precompiles
* @param assetIndex_ The asset index to get info for
* @return The token info for the asset
*/
function _getTokenInfo(uint32 assetIndex_) internal view returns (TokenInfo memory) {
(bool success, bytes memory result) = TOKEN_INFO_PRECOMPILE_ADDRESS.staticcall(abi.encode(assetIndex_));
require(success, Errors.PRECOMPILE_CALL_FAILED());
return abi.decode(result, (TokenInfo));
}
/**
* @notice Validates the spot market for a specific asset by querying the Hyperliquid Precompile
* @param assetIndex_ The asset index to validate
* @param spotMarket The spot market index to validate
* @return True if the spot market is valid, false otherwise
*/
function _validateSpotMarket(uint64 assetIndex_, uint32 spotMarket) internal view returns (bool) {
(bool success, bytes memory result) = SPOT_INFO_PRECOMPILE_ADDRESS.staticcall(abi.encode(spotMarket));
require(success, Errors.PRECOMPILE_CALL_FAILED());
SpotInfo memory spotInfo = abi.decode(result, (SpotInfo));
return (
(spotInfo.tokens[0] == assetIndex_ && spotInfo.tokens[1] == USDC_EVM_SPOT_INDEX)
|| (spotInfo.tokens[1] == assetIndex_ && spotInfo.tokens[0] == USDC_EVM_SPOT_INDEX)
);
}
/*//////////////////////////////////////////////////////////////
View Functions
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IHyperVaultRouter
function escrows(uint256 index) external view override returns (address) {
V1Storage storage $ = _getV1Storage();
return $.escrows[index];
}
/// @notice IHyperVaultRouter
function maxWithdrawable() public view override returns (uint256) {
V1Storage storage $ = _getV1Storage();
uint256 totalBalance = 0;
uint256 len = $.escrows.length;
for (uint256 i = 0; i < len; ++i) {
totalBalance += IERC20($.withdrawAsset).balanceOf($.escrows[i]);
}
return totalBalance;
}
/// @notice IHyperVaultRouter
function maxRedeemable() external view override returns (uint256) {
V1Storage storage $ = _getV1Storage();
uint64 assetIndex_ = $.assetIndexes[$.withdrawAsset];
AssetDetails memory details = $.assetDetails[assetIndex_];
// Convert the USD amount to withdraw to the withdraw asset amount
HyperliquidEscrow escrow = HyperliquidEscrow($.escrows[depositEscrowIndex()]);
uint256 scaler = 10 ** (18 - details.evmDecimals);
uint256 rate = _getRate(address(escrow), assetIndex_, details);
uint256 maxWithdraw = maxWithdrawable();
if (maxWithdraw == 0) return 0;
// Calculate the max redeemable amount based on the USD value of the withdraw asset
uint256 usdValue = maxWithdraw.mulWadDown(rate * scaler);
uint256 tvl_ = tvl();
if (tvl_ == 0) return 0;
uint256 feeShares = _previewFeeShares($, tvl_);
return usdValue.mulDivUp(_shareSupply() + feeShares, tvl_);
}
function previewDeposit(address asset, uint256 amount) external view returns (uint256 shares) {
V1Storage storage $ = _getV1Storage();
HyperliquidEscrow escrow = HyperliquidEscrow($.escrows[depositEscrowIndex()]);
uint64 assetIndex_ = $.assetIndexes[asset];
require(_isAssetSupported($, assetIndex_), Errors.COLLATERAL_NOT_SUPPORTED());
AssetDetails memory details = $.assetDetails[assetIndex_];
require(details.evmContract == asset, Errors.INVALID_EVM_ADDRESS());
// Get the USD value of the asset to properly calculate shares to mint
uint256 scaler = 10 ** (18 - details.evmDecimals);
uint256 rate = _getRate(address(escrow), assetIndex_, details);
uint256 usdValue = rate.mulWadDown(amount * scaler);
if (_shareSupply() == 0) {
shares = usdValue;
} else {
uint256 tvl_ = tvl();
uint256 feeShares = _previewFeeShares($, tvl_);
shares = usdValue.mulDivDown(_shareSupply() + feeShares, tvl_);
}
}
function previewRedeem(uint256 shares) external view returns (uint256 amount) {
V1Storage storage $ = _getV1Storage();
require(shares > 0, Errors.ZERO_SHARES());
require($.withdrawAsset != address(0), Errors.ADDRESS_ZERO());
uint256 tvl_ = tvl();
uint256 feeShares = _previewFeeShares($, tvl_);
uint256 totalExpectedShares = _shareSupply() + feeShares;
uint256 usdAmount = shares.mulDivDown(tvl_, totalExpectedShares);
// Get amount of withdraw asset from escrow
uint64 assetIndex_ = $.assetIndexes[$.withdrawAsset];
AssetDetails memory details = $.assetDetails[assetIndex_];
// Convert the USD amount to withdraw to the withdraw asset amount
HyperliquidEscrow escrow = HyperliquidEscrow($.escrows[depositEscrowIndex()]);
uint256 scaler = 10 ** (18 - details.evmDecimals);
uint256 rate = _getRate(address(escrow), assetIndex_, details);
amount = usdAmount.divWadDown(rate * scaler);
}
/// @inheritdoc IHyperVaultRouter
function assetIndex(address asset) external view override returns (uint64) {
V1Storage storage $ = _getV1Storage();
return $.assetIndexes[asset];
}
/// @notice IHyperVaultRouter
function withdrawAsset() external view override returns (address) {
V1Storage storage $ = _getV1Storage();
return $.withdrawAsset;
}
/// @notice IHyperVaultRouter
function isAssetSupported(uint64 assetIndex_) external view override returns (bool) {
V1Storage storage $ = _getV1Storage();
return _isAssetSupported($, assetIndex_);
}
/// @notice IHyperVaultRouter
function assetDetails(uint64 assetIndex_) external view override returns (AssetDetails memory) {
V1Storage storage $ = _getV1Storage();
return $.assetDetails[assetIndex_];
}
/// @notice IHyperVaultRouter
function lastFeeCollectionTimestamp() external view override returns (uint256) {
V1Storage storage $ = _getV1Storage();
return $.lastFeeCollectionTimestamp;
}
/// @notice IHyperVaultRouter
function managementFee() external view override returns (uint256) {
V1Storage storage $ = _getV1Storage();
return $.managementFeeBps;
}
/// @notice IHyperVaultRouter
function minDeposit() external view override returns (uint256) {
V1Storage storage $ = _getV1Storage();
return $.minDepositValue;
}
/// @notice IHyperVaultRouter
function feeRecipient() external view override returns (address) {
V1Storage storage $ = _getV1Storage();
return $.feeRecipient;
}
/*//////////////////////////////////////////////////////////////
Pure Functions
//////////////////////////////////////////////////////////////*/
/// @notice Retrieves the order storage
function _getV1Storage() private pure returns (V1Storage storage $) {
bytes32 slot = V1_HYPERVAULT_ROUTER_STORAGE_LOCATION;
assembly {
$.slot := slot
}
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.28;
import {BlueberryErrors as Errors} from "@blueberry-v2/helpers/BlueberryErrors.sol";
import {MintableToken} from "@blueberry-v2/utils/MintableToken.sol";
import {BlueberryErrors as Errors} from "@blueberry-v2/helpers/BlueberryErrors.sol";
import {HyperliquidEscrow} from "@blueberry-v2/vaults/hyperliquid/HyperliquidEscrow.sol";
import {HyperVaultRouter} from "@blueberry-v2/vaults/hyperliquid/HyperVaultRouter.sol";
contract WrappedVaultShare is MintableToken {
/*//////////////////////////////////////////////////////////////
Constants
//////////////////////////////////////////////////////////////*/
/// @notice The Router contract that will be used for deposits & redemptions of the token.
address public immutable ROUTER;
/*//////////////////////////////////////////////////////////////
Constructor
//////////////////////////////////////////////////////////////*/
constructor(string memory name, string memory symbol, address router, address admin)
MintableToken(name, symbol, 18, admin)
{
require(router != address(0), Errors.ADDRESS_ZERO());
ROUTER = router;
// Grant the minter and burner roles to the router so it can
// mint and burn share tokens during deposits and redemptions
_grantRole(MINTER_ROLE, router);
_grantRole(BURNER_ROLE, router);
}
/// @notice Calls the pokeFees functions on the router contract before any transfer
function _beforeTransfer() internal {
HyperVaultRouter(ROUTER).pokeFees();
}
/*//////////////////////////////////////////////////////////////
ERC20 Overrides
//////////////////////////////////////////////////////////////*/
/// @notice Overrides the ERC20 transfer function to enforce that fees are collected from the tvl
function transfer(address to_, uint256 amount_) public override returns (bool) {
_beforeTransfer();
return super.transfer(to_, amount_);
}
/// @notice Overrides the ERC20 transferFrom function to enforce that fees are collected from the tvl
function transferFrom(address from_, address to_, uint256 amount_) public override returns (bool) {
_beforeTransfer();
return super.transferFrom(from_, to_, amount_);
}
}// SPDX-License-Identifier: GPL-3.0
pragma solidity 0.8.28;
library BlueberryErrors {
/// @notice Error thrown when the admin tries to set a fee that is too high
error FEE_TOO_HIGH();
/// @notice Error thrown when an input address is zero
error ADDRESS_ZERO();
/// @notice Error thrown when an input amount is zero
error AMOUNT_ZERO();
/// @notice Error thrown when the user does not have enough balance
error USER_BALANCE_SMOL();
/// @notice Error thrown when the vault does not have enough balance to redeem
error VAULT_BALANCE_SMOL();
/// @notice Error thrown when the collateral is not supported
error COLLATERAL_NOT_SUPPORTED();
/// @notice Error thrown when the sender is not the vault
error INVALID_SENDER();
/// @notice Error thrown when the staticcall fails
error STATICCALL_FAILED();
/// @notice Error thrown when the minimum deposit amount is not met
error MIN_DEPOSIT_AMOUNT();
/// @notice Error thrown when not enough assets are fetched from the escrows
error FETCH_ASSETS_FAILED();
/// @notice Error thrown when the redeem request is not found
error REDEEM_REQUEST_NOT_FOUND();
/// @notice Error thrown when the transfer is blocked due to a pending redeem request
error TRANSFER_BLOCKED();
/// @notice Error thrown when a users balance is insufficient for burning a receipt token.
error INSUFFICIENT_BALANCE();
/// @notice Error thrown when a users withdraw request is too large
error WITHDRAW_TOO_LARGE();
/// @notice Error thrown when a users withdraw is too small
error WITHDRAW_TOO_SMALL();
/// @notice Error thrown when the perp decimals are invalid
error INVALID_PERP_DECIMALS();
/// @notice Error thrown when the vault equity is insufficient to withdraw
error INSUFFICIENT_VAULT_EQUITY();
/// @notice Error thrown when the fee recipient is invalid
error INVALID_FEE_RECIPIENT();
/// @notice Error thrown when the vault on Hyperliquid L1 is locked and cannot be used for withdrawals
error L1_VAULT_LOCKED();
/// @notice Error thrown when 0 shares are minted from a vault deposit
error ZERO_SHARES();
/// @notice Error thrown when there is an invalid amount of escrows deployed
error INVALID_ESCROW_COUNT();
/// @notice Error thrown when the escrow is invalid and the assets do not match
error INVALID_ESCROW();
/// @notice Error thrown when someone other than the owner tries to call redeem or withdraw
error OnlyOwnerCanWithdraw();
/// @notice Error thrown when a precompile call fails
error PRECOMPILE_CALL_FAILED();
/// @notice Error thrown the router tries to add an asset that is already supported
error ASSET_ALREADY_SUPPORTED();
/// @notice Error thrown when the router tries to remove an asset after the max number of assets is reached
error ASSET_LIMIT_EXCEEDED();
/// @notice Error thrown when the router tries to add an asset but there is a mismatch in the assets evm address
error INVALID_EVM_ADDRESS();
error INVALID_OPERATION();
error INVALID_SPOT_MARKET();
/// @notice Error thrown when too frequent admin actions are performed
error TOO_FREQUENT_ACTIONS();
/// @notice Error thrown when the length of the assets and amounts arrays do not match
error MISMATCHED_LENGTH();
/// @notice Error thrown when slippage is too high and the minimum amount is not met
error SLIPPAGE_TOO_HIGH();
/// @notice Error thrown when the TIF (Time in Force) is invalid
error INVALID_TIF();
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import {AccessControl} from "@openzeppelin/contracts/access/AccessControl.sol";
import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import {ERC20Burnable} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
import {ERC20Permit} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Permit.sol";
import {BlueberryErrors as Errors} from "@blueberry-v2/helpers/BlueberryErrors.sol";
/**
* @title MintableToken
* @notice An ERC20 token with minting and burning capabilities, protected by role-based access control
*/
contract MintableToken is ERC20, ERC20Burnable, AccessControl, ERC20Permit {
/*//////////////////////////////////////////////////////////////
Constants & Immutables
//////////////////////////////////////////////////////////////*/
/// @notice The MINTER_ROLE will be able to freely mint tokens as they see fit
bytes32 public constant MINTER_ROLE = keccak256("MINTER_ROLE");
/// @notice The BURNER_ROLE will be able to burn tokens from any address
bytes32 public constant BURNER_ROLE = keccak256("BURNER_ROLE");
/// @notice The number of decimals the token uses
uint8 private immutable _decimals;
/*//////////////////////////////////////////////////////////////
Constructor
//////////////////////////////////////////////////////////////*/
constructor(string memory name, string memory symbol, uint8 decimals_, address admin)
ERC20(name, symbol)
ERC20Permit(name)
{
_decimals = decimals_;
_grantRole(DEFAULT_ADMIN_ROLE, admin);
}
/*//////////////////////////////////////////////////////////////
Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Mints new tokens to a specific address
* @dev Only addresses with MINTER_ROLE can mint tokens
* @param to Address receiving the minted tokens
* @param amount Amount of tokens to mint
*/
function mint(address to, uint256 amount) public onlyRole(MINTER_ROLE) {
require(to != address(0), Errors.ADDRESS_ZERO());
_mint(to, amount);
}
/**
* @notice Burns tokens from a specific address
* @dev Only addresses with BURNER_ROLE can burn tokens
* @param from Address whose tokens will be burned
* @param amount Amount of tokens to burn
*/
function burnFrom(address from, uint256 amount) public override onlyRole(BURNER_ROLE) {
super.burnFrom(from, amount);
}
/**
* @notice Allows token holders to burn their own tokens
* @dev Overrides ERC20Burnable's burn to add role check to prevent people from burning their own tokens
* @param amount Amount of tokens to burn
*/
function burn(uint256 amount) public override onlyRole(BURNER_ROLE) {
super.burn(amount);
}
/// @inheritdoc ERC20
function decimals() public view override returns (uint8) {
return _decimals;
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.28;
import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import {FixedPointMathLib as FpMath} from "@solmate/utils/FixedPointMathLib.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {BlueberryErrors as Errors} from "@blueberry-v2/helpers/BlueberryErrors.sol";
import {L1EscrowActions} from "@blueberry-v2/vaults/hyperliquid/L1EscrowActions.sol";
import {IHyperliquidEscrow} from "@blueberry-v2/vaults/hyperliquid/interfaces/IHyperliquidEscrow.sol";
/**
* @title HyperliquidEscrow
* @author Blueberry
* @notice Holds assets for the Hyperliquid vault and provides functions for admins to actively allocate assets to
* different markets.
* @dev The top level of this contract contains all logic required for calculating the TVL of the escrow accounts on both evm & core.
* L1EscrowActions contains the logic for liquidity management and sending asssets to & from the L1.
* EscrowAssetStorage contains the logic for managing the assets supported by the escrow.
*/
contract HyperliquidEscrow is IHyperliquidEscrow, L1EscrowActions {
using EnumerableSet for EnumerableSet.UintSet;
using FpMath for uint64;
using FpMath for uint256;
/*//////////////////////////////////////////////////////////////
Constants & Immutables
//////////////////////////////////////////////////////////////*/
/*==== Precompile Addresses ====*/
/// @notice Precompile for accessing spot balance information
address constant SPOT_BALANCE_PRECOMPILE_ADDRESS = 0x0000000000000000000000000000000000000801;
/// @notice The address of the vault equity precompile, used for querying native L1 vault information & state.
address public constant VAULT_EQUITY_PRECOMPILE_ADDRESS = 0x0000000000000000000000000000000000000802;
/// @notice Precompile for querying withdrawable/free USDC funds from perps
address constant WITHDRAWABLE_PRECOMPILE_ADDRESS = 0x0000000000000000000000000000000000000803;
/// @notice Precompile for querying asset spot prices
address constant SPOT_PX_PRECOMPILE_ADDRESS = 0x0000000000000000000000000000000000000808;
/*==== USDC Constants ====*/
/// @notice The spot index for USDC
uint64 public constant USDC_SPOT_INDEX = 0;
/// @notice Decimals for USDC in perpetual markets (6 decimals)
uint8 public constant USDC_PERP_DECIMALS = 6;
/// @notice Decimals for USDC in spot markets (8 decimals)
uint8 public constant USDC_SPOT_DECIMALS = 8;
/// @notice Scaling factor for USDC in spot markets
uint256 public constant USDC_SPOT_SCALING = 10 ** (18 - USDC_SPOT_DECIMALS);
/// @notice Scaling factor for USDC in perpetual markets
uint256 public constant USDC_PERP_SCALING = 10 ** (18 - USDC_PERP_DECIMALS);
/// @notice The location for the vault escrow storage
bytes32 public constant V1_ESCROW_STORAGE_LOCATION =
keccak256(abi.encode(uint256(keccak256(bytes("vault.escrow.v1.storage"))) - 1)) & ~bytes32(uint256(0xff));
/*//////////////////////////////////////////////////////////////
Constructor & Initializer
//////////////////////////////////////////////////////////////*/
constructor(address vault, address router) L1EscrowActions(vault, router) {
require(vault != address(0) && router != address(0), Errors.ADDRESS_ZERO());
_disableInitializers();
}
function initialize(address admin) external initializer {
__AccessControl_init();
_grantRole(DEFAULT_ADMIN_ROLE, admin);
}
/*//////////////////////////////////////////////////////////////
External Functions
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IHyperliquidEscrow
function tvl() external view override returns (uint256 tvl_) {
// Get the equity, spot, and perp USD balances
tvl_ = vaultEquity(); // scaled to 1e18
tvl_ += usdSpotBalance(); // scaled to 1e18
tvl_ += usdPerpsBalance(); // scaled to 1e18
V1AssetStorage storage $ = _getV1AssetStorage();
V1L1EscrowActionsStorage storage $$ = _getV1L1EscrowActionsStorage();
// Iterate through all supported assets calculate their contract and spot value
// and add them to the tvl
for (uint256 i = 0; i < $.supportedAssets.length(); i++) {
uint64 assetIndex = uint64($.supportedAssets.at(i));
AssetDetails memory details = $.assetDetails[assetIndex];
address assetAddr = details.evmContract;
uint256 evmScaling = 10 ** (18 - details.evmDecimals);
uint256 lastBridgeToL1Block = $$.inFlightBridge[assetIndex].blockNumber;
if (assetIndex == USDC_SPOT_INDEX) {
// If the asset is USDC we only need to get the contract balance since we already queried the spot balance
tvl_ += IERC20(assetAddr).balanceOf(address(this)) * evmScaling;
// If we are still in the L1 bridge period (same EVM block as last bridge action took place), we need to add the in-flight bridge amounts
if (block.number == lastBridgeToL1Block) {
tvl_ += $$.inFlightBridge[assetIndex].amount * evmScaling;
}
} else {
uint256 rate = getRate(details.spotMarket, details.szDecimals);
uint256 balance = IERC20(assetAddr).balanceOf(address(this)) * evmScaling;
// If we are still in the L1 bridge period (same EVM block as last bridge action took place), we need to add the in-flight bridge amounts
if (block.number == lastBridgeToL1Block) {
balance += $$.inFlightBridge[assetIndex].amount * evmScaling;
}
balance += _spotAssetBalance(uint64(assetIndex));
tvl_ += balance.mulWadDown(rate);
}
}
}
/// @inheritdoc IHyperliquidEscrow
function usdSpotBalance() public view override returns (uint256) {
return _spotAssetBalance(USDC_SPOT_INDEX);
}
/// @inheritdoc IHyperliquidEscrow
function spotAssetBalance(uint64 token) external view override returns (uint256) {
return _spotAssetBalance(token);
}
/// @inheritdoc IHyperliquidEscrow
function usdPerpsBalance() public view override returns (uint256) {
(bool success, bytes memory result) = WITHDRAWABLE_PRECOMPILE_ADDRESS.staticcall(abi.encode(address(this)));
require(success, Errors.PRECOMPILE_CALL_FAILED());
Withdrawable memory withdrawable = abi.decode(result, (Withdrawable));
return uint256(withdrawable.withdrawable) * USDC_PERP_SCALING;
}
/// @inheritdoc IHyperliquidEscrow
function vaultEquity() public view override returns (uint256) {
(uint64 equity,) = _vaultEquity();
uint256 scaledEquity = equity * USDC_SPOT_SCALING;
return scaledEquity;
}
/// @inheritdoc IHyperliquidEscrow
function getRate(uint32 spotMarket, uint8 szDecimals) public view override returns (uint256) {
(bool success, bytes memory result) = SPOT_PX_PRECOMPILE_ADDRESS.staticcall(abi.encode(spotMarket));
require(success, Errors.PRECOMPILE_CALL_FAILED());
uint256 scaledRate = uint256(abi.decode(result, (uint64))) * USDC_SPOT_SCALING * (10 ** szDecimals);
return scaledRate;
}
/*//////////////////////////////////////////////////////////////
Internal Functions
//////////////////////////////////////////////////////////////*/
/// @dev Returns the vault equity and the locked until timestamp.
function _vaultEquity() internal view returns (uint64, uint64) {
(bool success, bytes memory result) =
VAULT_EQUITY_PRECOMPILE_ADDRESS.staticcall(abi.encode(address(this), L1_VAULT));
require(success, Errors.PRECOMPILE_CALL_FAILED());
UserVaultEquity memory userVaultEquity = abi.decode(result, (UserVaultEquity));
uint256 equityInSpot = _scaleToSpotDecimals(userVaultEquity.equity);
return (uint64(equityInSpot), userVaultEquity.lockedUntilTimestamp);
}
/**
* @notice Retrieves the spot balance for a specific asset scaled to 18 decimals.
* @param token The token index
* @return The spot balance for the specified asset
*/
function _spotAssetBalance(uint64 token) internal view override returns (uint256) {
V1AssetStorage storage $ = _getV1AssetStorage();
(bool success, bytes memory result) =
SPOT_BALANCE_PRECOMPILE_ADDRESS.staticcall(abi.encode(address(this), token));
require(success, Errors.PRECOMPILE_CALL_FAILED());
SpotBalance memory balance = abi.decode(result, (SpotBalance));
if (token == USDC_SPOT_INDEX) {
return balance.total * USDC_SPOT_SCALING;
}
uint256 scaler = 10 ** (18 - $.assetDetails[token].weiDecimals);
return balance.total * scaler;
}
/**
* @notice Scales an amount from perp decimals to spot/evm decimals.
* @param amount_ The amount to scale.
* @return The amount scaled to spot/evm decimals.
*/
function _scaleToSpotDecimals(uint64 amount_) internal pure returns (uint64) {
return uint64(amount_ * (10 ** (USDC_SPOT_DECIMALS - USDC_PERP_DECIMALS)));
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/AccessControl.sol)
pragma solidity ^0.8.20;
import {IAccessControl} from "./IAccessControl.sol";
import {Context} from "../utils/Context.sol";
import {ERC165} from "../utils/introspection/ERC165.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```solidity
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```solidity
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControl is Context, IAccessControl, ERC165 {
struct RoleData {
mapping(address account => bool) hasRole;
bytes32 adminRole;
}
mapping(bytes32 role => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with an {AccessControlUnauthorizedAccount} error including the required role.
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual returns (bool) {
return _roles[role].hasRole[account];
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
* is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
* is missing `role`.
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert AccessControlUnauthorizedAccount(account, role);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleGranted} event.
*/
function grantRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleRevoked} event.
*/
function revokeRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address callerConfirmation) public virtual {
if (callerConfirmation != _msgSender()) {
revert AccessControlBadConfirmation();
}
_revokeRole(role, callerConfirmation);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
bytes32 previousAdminRole = getRoleAdmin(role);
_roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
if (!hasRole(role, account)) {
_roles[role].hasRole[account] = true;
emit RoleGranted(role, account, _msgSender());
return true;
} else {
return false;
}
}
/**
* @dev Attempts to revoke `role` to `account` and returns a boolean indicating if `role` was revoked.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
if (hasRole(role, account)) {
_roles[role].hasRole[account] = false;
emit RoleRevoked(role, account, _msgSender());
return true;
} else {
return false;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (token/ERC20/ERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC-20
* applications.
*/
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
mapping(address account => uint256) private _balances;
mapping(address account => mapping(address spender => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `value`.
*/
function transfer(address to, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_transfer(owner, to, value);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 value) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, value);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `value`.
* - the caller must have allowance for ``from``'s tokens of at least
* `value`.
*/
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, value);
_transfer(from, to, value);
return true;
}
/**
* @dev Moves a `value` amount of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _transfer(address from, address to, uint256 value) internal {
if (from == address(0)) {
revert ERC20InvalidSender(address(0));
}
if (to == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(from, to, value);
}
/**
* @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
* (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
* this function.
*
* Emits a {Transfer} event.
*/
function _update(address from, address to, uint256 value) internal virtual {
if (from == address(0)) {
// Overflow check required: The rest of the code assumes that totalSupply never overflows
_totalSupply += value;
} else {
uint256 fromBalance = _balances[from];
if (fromBalance < value) {
revert ERC20InsufficientBalance(from, fromBalance, value);
}
unchecked {
// Overflow not possible: value <= fromBalance <= totalSupply.
_balances[from] = fromBalance - value;
}
}
if (to == address(0)) {
unchecked {
// Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
_totalSupply -= value;
}
} else {
unchecked {
// Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
_balances[to] += value;
}
}
emit Transfer(from, to, value);
}
/**
* @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
* Relies on the `_update` mechanism
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead.
*/
function _mint(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidReceiver(address(0));
}
_update(address(0), account, value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
* Relies on the `_update` mechanism.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* NOTE: This function is not virtual, {_update} should be overridden instead
*/
function _burn(address account, uint256 value) internal {
if (account == address(0)) {
revert ERC20InvalidSender(address(0));
}
_update(account, address(0), value);
}
/**
* @dev Sets `value` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*
* Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
*/
function _approve(address owner, address spender, uint256 value) internal {
_approve(owner, spender, value, true);
}
/**
* @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
*
* By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
* `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
* `Approval` event during `transferFrom` operations.
*
* Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
* true using the following override:
*
* ```solidity
* function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
* super._approve(owner, spender, value, true);
* }
* ```
*
* Requirements are the same as {_approve}.
*/
function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
if (owner == address(0)) {
revert ERC20InvalidApprover(address(0));
}
if (spender == address(0)) {
revert ERC20InvalidSpender(address(0));
}
_allowances[owner][spender] = value;
if (emitEvent) {
emit Approval(owner, spender, value);
}
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `value`.
*
* Does not update the allowance value in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Does not emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance < type(uint256).max) {
if (currentAllowance < value) {
revert ERC20InsufficientAllowance(spender, currentAllowance, value);
}
unchecked {
_approve(owner, spender, currentAllowance - value, false);
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/ERC20Burnable.sol)
pragma solidity ^0.8.20;
import {ERC20} from "../ERC20.sol";
import {Context} from "../../../utils/Context.sol";
/**
* @dev Extension of {ERC20} that allows token holders to destroy both their own
* tokens and those that they have an allowance for, in a way that can be
* recognized off-chain (via event analysis).
*/
abstract contract ERC20Burnable is Context, ERC20 {
/**
* @dev Destroys a `value` amount of tokens from the caller.
*
* See {ERC20-_burn}.
*/
function burn(uint256 value) public virtual {
_burn(_msgSender(), value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, deducting from
* the caller's allowance.
*
* See {ERC20-_burn} and {ERC20-allowance}.
*
* Requirements:
*
* - the caller must have allowance for ``accounts``'s tokens of at least
* `value`.
*/
function burnFrom(address account, uint256 value) public virtual {
_spendAllowance(account, _msgSender(), value);
_burn(account, value);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/ERC20Permit.sol)
pragma solidity ^0.8.20;
import {IERC20Permit} from "./IERC20Permit.sol";
import {ERC20} from "../ERC20.sol";
import {ECDSA} from "../../../utils/cryptography/ECDSA.sol";
import {EIP712} from "../../../utils/cryptography/EIP712.sol";
import {Nonces} from "../../../utils/Nonces.sol";
/**
* @dev Implementation of the ERC-20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[ERC-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC-20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on `{IERC20-approve}`, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712, Nonces {
bytes32 private constant PERMIT_TYPEHASH =
keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)");
/**
* @dev Permit deadline has expired.
*/
error ERC2612ExpiredSignature(uint256 deadline);
/**
* @dev Mismatched signature.
*/
error ERC2612InvalidSigner(address signer, address owner);
/**
* @dev Initializes the {EIP712} domain separator using the `name` parameter, and setting `version` to `"1"`.
*
* It's a good idea to use the same `name` that is defined as the ERC-20 token name.
*/
constructor(string memory name) EIP712(name, "1") {}
/**
* @inheritdoc IERC20Permit
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) public virtual {
if (block.timestamp > deadline) {
revert ERC2612ExpiredSignature(deadline);
}
bytes32 structHash = keccak256(abi.encode(PERMIT_TYPEHASH, owner, spender, value, _useNonce(owner), deadline));
bytes32 hash = _hashTypedDataV4(structHash);
address signer = ECDSA.recover(hash, v, r, s);
if (signer != owner) {
revert ERC2612InvalidSigner(signer, owner);
}
_approve(owner, spender, value);
}
/**
* @inheritdoc IERC20Permit
*/
function nonces(address owner) public view virtual override(IERC20Permit, Nonces) returns (uint256) {
return super.nonces(owner);
}
/**
* @inheritdoc IERC20Permit
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view virtual returns (bytes32) {
return _domainSeparatorV4();
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/structs/EnumerableSet.sol)
// This file was procedurally generated from scripts/generate/templates/EnumerableSet.js.
pragma solidity ^0.8.20;
/**
* @dev Library for managing
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
* types.
*
* Sets have the following properties:
*
* - Elements are added, removed, and checked for existence in constant time
* (O(1)).
* - Elements are enumerated in O(n). No guarantees are made on the ordering.
*
* ```solidity
* contract Example {
* // Add the library methods
* using EnumerableSet for EnumerableSet.AddressSet;
*
* // Declare a set state variable
* EnumerableSet.AddressSet private mySet;
* }
* ```
*
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
* and `uint256` (`UintSet`) are supported.
*
* [WARNING]
* ====
* Trying to delete such a structure from storage will likely result in data corruption, rendering the structure
* unusable.
* See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info.
*
* In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an
* array of EnumerableSet.
* ====
*/
library EnumerableSet {
// To implement this library for multiple types with as little code
// repetition as possible, we write it in terms of a generic Set type with
// bytes32 values.
// The Set implementation uses private functions, and user-facing
// implementations (such as AddressSet) are just wrappers around the
// underlying Set.
// This means that we can only create new EnumerableSets for types that fit
// in bytes32.
struct Set {
// Storage of set values
bytes32[] _values;
// Position is the index of the value in the `values` array plus 1.
// Position 0 is used to mean a value is not in the set.
mapping(bytes32 value => uint256) _positions;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function _add(Set storage set, bytes32 value) private returns (bool) {
if (!_contains(set, value)) {
set._values.push(value);
// The value is stored at length-1, but we add 1 to all indexes
// and use 0 as a sentinel value
set._positions[value] = set._values.length;
return true;
} else {
return false;
}
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function _remove(Set storage set, bytes32 value) private returns (bool) {
// We cache the value's position to prevent multiple reads from the same storage slot
uint256 position = set._positions[value];
if (position != 0) {
// Equivalent to contains(set, value)
// To delete an element from the _values array in O(1), we swap the element to delete with the last one in
// the array, and then remove the last element (sometimes called as 'swap and pop').
// This modifies the order of the array, as noted in {at}.
uint256 valueIndex = position - 1;
uint256 lastIndex = set._values.length - 1;
if (valueIndex != lastIndex) {
bytes32 lastValue = set._values[lastIndex];
// Move the lastValue to the index where the value to delete is
set._values[valueIndex] = lastValue;
// Update the tracked position of the lastValue (that was just moved)
set._positions[lastValue] = position;
}
// Delete the slot where the moved value was stored
set._values.pop();
// Delete the tracked position for the deleted slot
delete set._positions[value];
return true;
} else {
return false;
}
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function _contains(Set storage set, bytes32 value) private view returns (bool) {
return set._positions[value] != 0;
}
/**
* @dev Returns the number of values on the set. O(1).
*/
function _length(Set storage set) private view returns (uint256) {
return set._values.length;
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function _at(Set storage set, uint256 index) private view returns (bytes32) {
return set._values[index];
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function _values(Set storage set) private view returns (bytes32[] memory) {
return set._values;
}
// Bytes32Set
struct Bytes32Set {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _add(set._inner, value);
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {
return _remove(set._inner, value);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {
return _contains(set._inner, value);
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(Bytes32Set storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {
return _at(set._inner, index);
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {
bytes32[] memory store = _values(set._inner);
bytes32[] memory result;
assembly ("memory-safe") {
result := store
}
return result;
}
// AddressSet
struct AddressSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(AddressSet storage set, address value) internal returns (bool) {
return _add(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(AddressSet storage set, address value) internal returns (bool) {
return _remove(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(AddressSet storage set, address value) internal view returns (bool) {
return _contains(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(AddressSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(AddressSet storage set, uint256 index) internal view returns (address) {
return address(uint160(uint256(_at(set._inner, index))));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(AddressSet storage set) internal view returns (address[] memory) {
bytes32[] memory store = _values(set._inner);
address[] memory result;
assembly ("memory-safe") {
result := store
}
return result;
}
// UintSet
struct UintSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/
function add(UintSet storage set, uint256 value) internal returns (bool) {
return _add(set._inner, bytes32(value));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/
function remove(UintSet storage set, uint256 value) internal returns (bool) {
return _remove(set._inner, bytes32(value));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/
function contains(UintSet storage set, uint256 value) internal view returns (bool) {
return _contains(set._inner, bytes32(value));
}
/**
* @dev Returns the number of values in the set. O(1).
*/
function length(UintSet storage set) internal view returns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/
function at(UintSet storage set, uint256 index) internal view returns (uint256) {
return uint256(_at(set._inner, index));
}
/**
* @dev Return the entire set in an array
*
* WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed
* to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that
* this function has an unbounded cost, and using it as part of a state-changing function may render the function
* uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.
*/
function values(UintSet storage set) internal view returns (uint256[] memory) {
bytes32[] memory store = _values(set._inner);
uint256[] memory result;
assembly ("memory-safe") {
result := store
}
return result;
}
}// SPDX-License-Identifier: AGPL-3.0-only
pragma solidity >=0.8.0;
/// @notice Arithmetic library with operations for fixed-point numbers.
/// @author Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/FixedPointMathLib.sol)
/// @author Inspired by USM (https://github.com/usmfum/USM/blob/master/contracts/WadMath.sol)
library FixedPointMathLib {
/*//////////////////////////////////////////////////////////////
SIMPLIFIED FIXED POINT OPERATIONS
//////////////////////////////////////////////////////////////*/
uint256 internal constant MAX_UINT256 = 2**256 - 1;
uint256 internal constant WAD = 1e18; // The scalar of ETH and most ERC20s.
function mulWadDown(uint256 x, uint256 y) internal pure returns (uint256) {
return mulDivDown(x, y, WAD); // Equivalent to (x * y) / WAD rounded down.
}
function mulWadUp(uint256 x, uint256 y) internal pure returns (uint256) {
return mulDivUp(x, y, WAD); // Equivalent to (x * y) / WAD rounded up.
}
function divWadDown(uint256 x, uint256 y) internal pure returns (uint256) {
return mulDivDown(x, WAD, y); // Equivalent to (x * WAD) / y rounded down.
}
function divWadUp(uint256 x, uint256 y) internal pure returns (uint256) {
return mulDivUp(x, WAD, y); // Equivalent to (x * WAD) / y rounded up.
}
/*//////////////////////////////////////////////////////////////
LOW LEVEL FIXED POINT OPERATIONS
//////////////////////////////////////////////////////////////*/
function mulDivDown(
uint256 x,
uint256 y,
uint256 denominator
) internal pure returns (uint256 z) {
/// @solidity memory-safe-assembly
assembly {
// Equivalent to require(denominator != 0 && (y == 0 || x <= type(uint256).max / y))
if iszero(mul(denominator, iszero(mul(y, gt(x, div(MAX_UINT256, y)))))) {
revert(0, 0)
}
// Divide x * y by the denominator.
z := div(mul(x, y), denominator)
}
}
function mulDivUp(
uint256 x,
uint256 y,
uint256 denominator
) internal pure returns (uint256 z) {
/// @solidity memory-safe-assembly
assembly {
// Equivalent to require(denominator != 0 && (y == 0 || x <= type(uint256).max / y))
if iszero(mul(denominator, iszero(mul(y, gt(x, div(MAX_UINT256, y)))))) {
revert(0, 0)
}
// If x * y modulo the denominator is strictly greater than 0,
// 1 is added to round up the division of x * y by the denominator.
z := add(gt(mod(mul(x, y), denominator), 0), div(mul(x, y), denominator))
}
}
function rpow(
uint256 x,
uint256 n,
uint256 scalar
) internal pure returns (uint256 z) {
/// @solidity memory-safe-assembly
assembly {
switch x
case 0 {
switch n
case 0 {
// 0 ** 0 = 1
z := scalar
}
default {
// 0 ** n = 0
z := 0
}
}
default {
switch mod(n, 2)
case 0 {
// If n is even, store scalar in z for now.
z := scalar
}
default {
// If n is odd, store x in z for now.
z := x
}
// Shifting right by 1 is like dividing by 2.
let half := shr(1, scalar)
for {
// Shift n right by 1 before looping to halve it.
n := shr(1, n)
} n {
// Shift n right by 1 each iteration to halve it.
n := shr(1, n)
} {
// Revert immediately if x ** 2 would overflow.
// Equivalent to iszero(eq(div(xx, x), x)) here.
if shr(128, x) {
revert(0, 0)
}
// Store x squared.
let xx := mul(x, x)
// Round to the nearest number.
let xxRound := add(xx, half)
// Revert if xx + half overflowed.
if lt(xxRound, xx) {
revert(0, 0)
}
// Set x to scaled xxRound.
x := div(xxRound, scalar)
// If n is even:
if mod(n, 2) {
// Compute z * x.
let zx := mul(z, x)
// If z * x overflowed:
if iszero(eq(div(zx, x), z)) {
// Revert if x is non-zero.
if iszero(iszero(x)) {
revert(0, 0)
}
}
// Round to the nearest number.
let zxRound := add(zx, half)
// Revert if zx + half overflowed.
if lt(zxRound, zx) {
revert(0, 0)
}
// Return properly scaled zxRound.
z := div(zxRound, scalar)
}
}
}
}
}
/*//////////////////////////////////////////////////////////////
GENERAL NUMBER UTILITIES
//////////////////////////////////////////////////////////////*/
function sqrt(uint256 x) internal pure returns (uint256 z) {
/// @solidity memory-safe-assembly
assembly {
let y := x // We start y at x, which will help us make our initial estimate.
z := 181 // The "correct" value is 1, but this saves a multiplication later.
// This segment is to get a reasonable initial estimate for the Babylonian method. With a bad
// start, the correct # of bits increases ~linearly each iteration instead of ~quadratically.
// We check y >= 2^(k + 8) but shift right by k bits
// each branch to ensure that if x >= 256, then y >= 256.
if iszero(lt(y, 0x10000000000000000000000000000000000)) {
y := shr(128, y)
z := shl(64, z)
}
if iszero(lt(y, 0x1000000000000000000)) {
y := shr(64, y)
z := shl(32, z)
}
if iszero(lt(y, 0x10000000000)) {
y := shr(32, y)
z := shl(16, z)
}
if iszero(lt(y, 0x1000000)) {
y := shr(16, y)
z := shl(8, z)
}
// Goal was to get z*z*y within a small factor of x. More iterations could
// get y in a tighter range. Currently, we will have y in [256, 256*2^16).
// We ensured y >= 256 so that the relative difference between y and y+1 is small.
// That's not possible if x < 256 but we can just verify those cases exhaustively.
// Now, z*z*y <= x < z*z*(y+1), and y <= 2^(16+8), and either y >= 256, or x < 256.
// Correctness can be checked exhaustively for x < 256, so we assume y >= 256.
// Then z*sqrt(y) is within sqrt(257)/sqrt(256) of sqrt(x), or about 20bps.
// For s in the range [1/256, 256], the estimate f(s) = (181/1024) * (s+1) is in the range
// (1/2.84 * sqrt(s), 2.84 * sqrt(s)), with largest error when s = 1 and when s = 256 or 1/256.
// Since y is in [256, 256*2^16), let a = y/65536, so that a is in [1/256, 256). Then we can estimate
// sqrt(y) using sqrt(65536) * 181/1024 * (a + 1) = 181/4 * (y + 65536)/65536 = 181 * (y + 65536)/2^18.
// There is no overflow risk here since y < 2^136 after the first branch above.
z := shr(18, mul(z, add(y, 65536))) // A mul() is saved from starting z at 181.
// Given the worst case multiplicative error of 2.84 above, 7 iterations should be enough.
z := shr(1, add(z, div(x, z)))
z := shr(1, add(z, div(x, z)))
z := shr(1, add(z, div(x, z)))
z := shr(1, add(z, div(x, z)))
z := shr(1, add(z, div(x, z)))
z := shr(1, add(z, div(x, z)))
z := shr(1, add(z, div(x, z)))
// If x+1 is a perfect square, the Babylonian method cycles between
// floor(sqrt(x)) and ceil(sqrt(x)). This statement ensures we return floor.
// See: https://en.wikipedia.org/wiki/Integer_square_root#Using_only_integer_division
// Since the ceil is rare, we save gas on the assignment and repeat division in the rare case.
// If you don't care whether the floor or ceil square root is returned, you can remove this statement.
z := sub(z, lt(div(x, z), z))
}
}
function unsafeMod(uint256 x, uint256 y) internal pure returns (uint256 z) {
/// @solidity memory-safe-assembly
assembly {
// Mod x by y. Note this will return
// 0 instead of reverting if y is zero.
z := mod(x, y)
}
}
function unsafeDiv(uint256 x, uint256 y) internal pure returns (uint256 r) {
/// @solidity memory-safe-assembly
assembly {
// Divide x by y. Note this will return
// 0 instead of reverting if y is zero.
r := div(x, y)
}
}
function unsafeDivUp(uint256 x, uint256 y) internal pure returns (uint256 z) {
/// @solidity memory-safe-assembly
assembly {
// Add 1 to x * y if x % y > 0. Note this will
// return 0 instead of reverting if y is zero.
z := add(gt(mod(x, y), 0), div(x, y))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @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: BUSL-1.1
pragma solidity 0.8.28;
import {AccessControlUpgradeable} from "@openzeppelin-contracts-upgradeable/access/AccessControlUpgradeable.sol";
import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {BlueberryErrors as Errors} from "@blueberry-v2/helpers/BlueberryErrors.sol";
import {EscrowAssetStorage} from "@blueberry-v2/vaults/hyperliquid/EscrowAssetStorage.sol";
import {ICoreWriter} from "@blueberry-v2/vaults/hyperliquid/interfaces/ICoreWriter.sol";
/**
* @title L1EscrowActions
* @author Blueberry
* @notice This contract contains the admin logic for
*/
abstract contract L1EscrowActions is EscrowAssetStorage, AccessControlUpgradeable {
using EnumerableSet for EnumerableSet.UintSet;
using SafeERC20 for IERC20;
/*//////////////////////////////////////////////////////////////
Structs
//////////////////////////////////////////////////////////////*/
/// @notice Struct that contains details on the last time an asset was bridged to L1
struct InflightBridge {
/// @notice The evm block number that the asset was sent to L1
uint64 blockNumber;
/// @notice The amount of the asset that is in-flight to L1
uint256 amount;
}
/// @notice Struct that encodes the params for sending tokens to spot accounts
struct SpotSendParams {
/// @notice Destination address to send the asset to
address destination;
/// @notice The index of the asset to send
uint64 token;
/// @notice The amount of the asset to send
uint64 _wei;
}
/// @notice Struct that encodes the params for transferring USDC between perp & spot accounts
struct UsdClassTransferParams {
/// @notice Amount of USDC to transfer
uint64 ntl;
/// @notice True if transferring from spot to perp, false if transferring from perp to spot
bool toPerp;
}
/// @notice Struct that encodes the params depositing or withdrawing from a vault
struct VaultTransferParams {
/// @notice Address of the target vault
address vault;
/// @notice True if depositing to the vault, false if withdrawing from the vault
bool isDeposit;
/// @notice Amount of USDC to deposit or withdraw
uint64 usd;
}
/// @notice Struct that encodes the params for a limit order
struct LimitOrderParams {
/// @notice The index of the asset to trade
uint32 asset;
/// @notice True if the order is a buy order, false if it is a sell order
bool isBuy;
/// @notice The price at which the order should be executed
uint64 limitPx;
/// @notice The amount of the asset to trade
uint64 sz;
/// @notice True to reduce or close a position, false to open a new position
bool reduceOnly;
/// @notice The time in force for the order, 1 = Alo, 2 = Gtc, 3 = IOC
uint8 encodedTif;
/// @notice Client Order ID; 0 if not used
uint128 cloid;
}
/*//////////////////////////////////////////////////////////////
Storage
//////////////////////////////////////////////////////////////*/
/// @custom:storage-location erc7201:l1.escrow.actions.v1.storage
struct V1L1EscrowActionsStorage {
/// @notice Last block number that an admin action was performed
uint256 lastAdminActionBlock;
/// @notice A mapping of asset indexes to their corresponding in-flight bridge struct
mapping(uint64 => InflightBridge) inFlightBridge;
}
/*//////////////////////////////////////////////////////////////
Constants
//////////////////////////////////////////////////////////////*/
/// @notice The L1 vault address that is being tokenized
address public immutable L1_VAULT;
/*==== Precompile Addresses ====*/
/// @notice The address of the write precompile, used for sending transactions to the L1.
ICoreWriter public constant L1_CORE_WRITER = ICoreWriter(0x3333333333333333333333333333333333333333);
uint8 public constant CORE_WRITER_VERSION_1 = 1;
uint24 public constant CORE_WRITER_ACTION_LIMIT_ORDER = 1;
uint24 public constant CORE_WRITER_ACTION_VAULT_TRANSFER = 2;
uint24 public constant CORE_WRITER_ACTION_SPOT_SEND = 6;
uint24 public constant CORE_WRITER_ACTION_USD_CLASS_TRANSFER = 7;
uint8 public constant LIMIT_ORDER_TIF_ALO = 1;
uint8 public constant LIMIT_ORDER_TIF_GTC = 2;
uint8 public constant LIMIT_ORDER_TIF_IOC = 3;
/*==== Additional Constants ====*/
/// @notice Spot market indexes start at index 10000
uint32 public constant SPOT_MARKET_INDEX_OFFSET = 10000;
/// @notice The role that is granted to the admin who can direct the escrows liquidity
bytes32 public constant LIQUIDITY_ADMIN_ROLE = keccak256("LIQUIDITY_ADMIN_ROLE");
/// @notice The location for the vault escrow storage
bytes32 public constant V1_L1_ESCROW_ACTIONS_STORAGE_LOCATION =
keccak256(abi.encode(uint256(keccak256(bytes("l1.escrow.actions.v1.storage"))) - 1)) & ~bytes32(uint256(0xff));
/*//////////////////////////////////////////////////////////////
Modifiers
//////////////////////////////////////////////////////////////*/
// This modifier prevents contract admins from interacting with the contract multiple
// times within a single evm block. This is to protect from the lag time in contract
// state that occurs between L1 on Hyperliquid Core.
modifier singleActionBlock() {
V1L1EscrowActionsStorage storage $ = _getV1L1EscrowActionsStorage();
require(block.number > $.lastAdminActionBlock, Errors.TOO_FREQUENT_ACTIONS());
$.lastAdminActionBlock = block.number;
_;
}
constructor(address vault, address router) EscrowAssetStorage(router) {
L1_VAULT = vault;
}
/*//////////////////////////////////////////////////////////////
External Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Bridge assets to the escrows L1 spot account
* @param assetIndex The index of the assets to bridge
* @param amount The amounts of the assets to bridge
*/
function bridgeToL1(uint64 assetIndex, uint256 amount) external onlyRole(LIQUIDITY_ADMIN_ROLE) singleActionBlock {
V1AssetStorage storage $ = _getV1AssetStorage();
V1L1EscrowActionsStorage storage $$ = _getV1L1EscrowActionsStorage();
AssetDetails memory details = $.assetDetails[assetIndex];
require(details.evmContract != address(0), Errors.ADDRESS_ZERO());
// Sanitize the amount to the correct spot decimals so that we dont lose small amounts in the
// bridging process.
uint256 factor =
(details.evmDecimals > details.weiDecimals) ? 10 ** (details.evmDecimals - details.weiDecimals) : 1;
uint256 amountAdjusted = amount - (amount % factor);
IERC20(details.evmContract).transfer(_assetSystemAddr(assetIndex), amountAdjusted);
// Update the in-flight bridge struct with the new amount sent and block number
$$.inFlightBridge[assetIndex] = InflightBridge({blockNumber: uint64(block.number), amount: amountAdjusted});
}
/**
* @notice Bridges a spot asset from the L1 to the escrow's evm contract
* @dev No balance validation is necessary since we track the balances of all account types to calculate tvl,
* so any failures can simply be retried with different parameters.
* @param assetIndex The index of the asset to bridge
* @param amount The amount of the assets to pull
*/
function bridgeFromL1(uint64 assetIndex, uint64 amount) external onlyRole(LIQUIDITY_ADMIN_ROLE) singleActionBlock {
require(isAssetSupported(assetIndex), Errors.COLLATERAL_NOT_SUPPORTED());
_spotSend(assetIndex, amount);
}
/**
* @notice Executes an IOC order on the L1
* @dev No balance/price validation is necessary since we track the balances of all account types to calculate tvl,
* so any failures can simply be retried with different parameters.
* @param assetIndex The index of the asset to trade
* @param isBuy Whether to buy or sell
* @param limitPx The limit price
* @param sz The size of the trade
* @param tif The time in force for the order, 1 = Alo, 2 = Gtc, 3 = IOC
*/
function trade(uint32 assetIndex, bool isBuy, uint64 limitPx, uint64 sz, uint8 tif)
external
onlyRole(LIQUIDITY_ADMIN_ROLE)
singleActionBlock
{
V1AssetStorage storage $ = _getV1AssetStorage();
require($.supportedAssets.contains(assetIndex), Errors.COLLATERAL_NOT_SUPPORTED());
uint32 iocIndex = SPOT_MARKET_INDEX_OFFSET + $.assetDetails[assetIndex].spotMarket;
_limitOrder(iocIndex, isBuy, limitPx, sz, tif);
}
/**
* @notice Transfers spot USDC to perps
* @dev No balance validation is necessary since we track the balances of all account types to calculate tvl,
* so any failures can simply be retried with different parameters.
* @param amount The amount of USDC in spot to transfer
*/
function spotToPerps(uint64 amount) external onlyRole(LIQUIDITY_ADMIN_ROLE) singleActionBlock {
_usdClassTransfer(amount, true);
}
/**
* @notice Transfers perps USDC to spot
* @dev No balance validation is necessary since we track the balances of all account types to calculate tvl,
* so any failures can simply be retried with different parameters.
* @param amount The amount of USDC in perps to transfer
*/
function perpsToSpot(uint64 amount) external onlyRole(LIQUIDITY_ADMIN_ROLE) singleActionBlock {
_usdClassTransfer(amount, false);
}
/**
* @notice Deposits USDC into the vault
* @dev No balance validation is necessary since we track the balances of all account types to calculate tvl,
* so any failures can simply be retried with different parameters.
* @param amount The amount of USDC in perps to deposit
*/
function vaultDeposit(uint64 amount) external onlyRole(LIQUIDITY_ADMIN_ROLE) singleActionBlock {
_vaultTransfer(amount, true);
}
/**
* @notice Withdraws USDC from the vault
* @dev No balance validation is necessary since we track the balances of all account types to calculate tvl,
* so any failures can simply be retried with different parameters.
* @param amount The amount of USDC in perps to withdraw
*/
function vaultWithdraw(uint64 amount) external onlyRole(LIQUIDITY_ADMIN_ROLE) singleActionBlock {
_vaultTransfer(amount, false);
}
/*///////////////////////////////////////////////////////////////
Internal Functions
//////////////////////////////////////////////////////////////*/
/// @inheritdoc EscrowAssetStorage
function _inflightBalance(uint64 assetIndex) internal view override returns (uint256) {
V1L1EscrowActionsStorage storage $ = _getV1L1EscrowActionsStorage();
if (block.number != $.inFlightBridge[assetIndex].blockNumber) return 0;
return $.inFlightBridge[assetIndex].amount;
}
/*//////////////////////////////////////////////////////////////
Write Precompile Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Encodes and sends SpotSendParams w/ a spot send action to the L1 Core Writer
* @param assetIndex The index of the asset to send
* @param amount The amount of the asset to send
*/
function _spotSend(uint64 assetIndex, uint64 amount) internal {
SpotSendParams memory action =
SpotSendParams({destination: _assetSystemAddr(assetIndex), token: assetIndex, _wei: amount});
L1_CORE_WRITER.sendRawAction(_encodeSpotSend(action));
}
/// @notice Encodes SpotSendParams into bytes for sending to the L1 Core Writer
function _encodeSpotSend(SpotSendParams memory params) internal pure returns (bytes memory) {
return abi.encodePacked(CORE_WRITER_VERSION_1, CORE_WRITER_ACTION_SPOT_SEND, abi.encode(params));
}
/**
* @notice Encodes and sends UsdClassTransferParams w/ a usd class transfer action to the L1 Core Writer
* @param amount The amount of USDC to transfer
* @param toPerp True if transferring from spot to perp, false if transferring from perp to spot
*/
function _usdClassTransfer(uint64 amount, bool toPerp) internal {
UsdClassTransferParams memory params = UsdClassTransferParams(amount, toPerp);
L1_CORE_WRITER.sendRawAction(_encodeUsdClassTransfer(params));
}
/// @notice Encodes UsdClassTransferParams into bytes for sending to the L1 Core Writer
function _encodeUsdClassTransfer(UsdClassTransferParams memory params) internal pure returns (bytes memory) {
return abi.encodePacked(CORE_WRITER_VERSION_1, CORE_WRITER_ACTION_USD_CLASS_TRANSFER, abi.encode(params));
}
/**
* @notice Encodes and sends VaultTransferParams w/ a vault transfer action to the L1 Core Writer
* @param amount The amount of USDC to deposit or withdraw
* @param isDeposit True if depositing to the vault, false if withdrawing from the vault
*/
function _vaultTransfer(uint64 amount, bool isDeposit) internal {
VaultTransferParams memory params = VaultTransferParams({vault: L1_VAULT, isDeposit: isDeposit, usd: amount});
L1_CORE_WRITER.sendRawAction(_encodeVaultTransfer(params));
}
/// @notice Encodes UsdClassTransferParams into bytes for sending to the L1 Core Writer
function _encodeVaultTransfer(VaultTransferParams memory params) internal pure returns (bytes memory) {
return abi.encodePacked(CORE_WRITER_VERSION_1, CORE_WRITER_ACTION_VAULT_TRANSFER, abi.encode(params));
}
/**
* @notice Encodes and sends LimitOrderParams w/ a limit order action to the L1 Core Writer
* @param iocIndex The index of the asset to trade
* @param isBuy Whether to buy or sell
* @param limitPx The limit price
* @param sz The size of the trade
*/
function _limitOrder(uint32 iocIndex, bool isBuy, uint64 limitPx, uint64 sz, uint8 tif) internal {
require(
tif == LIMIT_ORDER_TIF_ALO || tif == LIMIT_ORDER_TIF_GTC || tif == LIMIT_ORDER_TIF_IOC, Errors.INVALID_TIF()
);
LimitOrderParams memory params = LimitOrderParams({
asset: iocIndex,
isBuy: isBuy,
limitPx: limitPx,
sz: sz,
reduceOnly: false,
encodedTif: tif,
cloid: 0
});
L1_CORE_WRITER.sendRawAction(_encodeLimitOrderParams(params));
}
/// @notice Encodes a LimitOrderParams into bytes for sending to the L1 Core Writer
function _encodeLimitOrderParams(LimitOrderParams memory params) internal pure returns (bytes memory) {
return abi.encodePacked(CORE_WRITER_VERSION_1, CORE_WRITER_ACTION_LIMIT_ORDER, abi.encode(params));
}
/*//////////////////////////////////////////////////////////////
View Functions
//////////////////////////////////////////////////////////////*/
/// @notice Returns the last block number that a LIQUIDITY_ADMIN_ROLE action was performed
function lastAdminActionBlock() public view returns (uint256) {
V1L1EscrowActionsStorage storage $ = _getV1L1EscrowActionsStorage();
return $.lastAdminActionBlock;
}
/*//////////////////////////////////////////////////////////////
Pure Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Returns the L1 actions storage
* @return $ The L1 actions storage
*/
function _getV1L1EscrowActionsStorage() internal pure returns (V1L1EscrowActionsStorage storage $) {
bytes32 slot = V1_L1_ESCROW_ACTIONS_STORAGE_LOCATION;
assembly {
$.slot := slot
}
}
/**
* @notice Returns the system address for an asset
* @param token The token index
* @return The system address for the asset
*/
function _assetSystemAddr(uint64 token) internal pure returns (address) {
uint160 base = uint160(0x2000000000000000000000000000000000000000);
return address(base | uint160(token));
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.28;
import {IHyperliquidCommon} from "@blueberry-v2/vaults/hyperliquid/interfaces/IHyperliquidCommon.sol";
/**
* @title IHyperliquidEscrow
*/
interface IHyperliquidEscrow is IHyperliquidCommon {
/*//////////////////////////////////////////////////////////////
Structs
//////////////////////////////////////////////////////////////*/
/// @notice Hyperliquid precompile struct: Spot balance information
struct SpotBalance {
uint64 total;
uint64 hold;
uint64 entryNtl;
}
/**
* @notice Hyperliquid precompile struct: Withdrawable information
* @dev used to get the amount of free USDC within the perps account
*/
struct Withdrawable {
uint64 withdrawable;
}
/// @notice Hyperliquid precompile struct: Vault equity information
struct UserVaultEquity {
uint64 equity;
uint64 lockedUntilTimestamp;
}
/**
* @notice Returns the total value locked (TVL) in the escrow in terms of USD
* @dev The TVL is scaled to 18 decimals.
* Formulated as:
* - Equity in Vault
* - USDC Perps Balance
* - USDC Spot Balance
* - All Supported Asset Spot Balance (skip USDC)
* - All Supported Asset Contract Balance
* @return tvl_ The total value locked in the escrow with 18 decimals
*/
function tvl() external view returns (uint256 tvl_);
/**
* @notice Returns the USDC spot balance
* @return The USDC spot balance scaled to 18 decimals
*/
function usdSpotBalance() external view returns (uint256);
/**
* @notice Returns the spot balance for a specific asset in terms of USD
* @dev The balance is scaled to 18 decimals.
* @param token The token index
* @return The spot balance for the specified asset
*/
function spotAssetBalance(uint64 token) external view returns (uint256);
/**
* @notice Returns the vault equity
* @return The vault equity in USD with 18 decimals
*/
function vaultEquity() external view returns (uint256);
/**
* @notice Returns the USD perps balance
* @return The USD perps balance with 18 decimals
*/
function usdPerpsBalance() external view returns (uint256);
/**
* @notice Returns the exchange rate of a token in USD
* @param spotMarket The Spot Market index of a token
* @param szDecimals The number of decimals that spot prices are returned with
* @return The exchange rate in USD with 18 decimals
*/
function getRate(uint32 spotMarket, uint8 szDecimals) external view returns (uint256);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.20;
import {OwnableUpgradeable} from "./OwnableUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which provides access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* This extension of the {Ownable} contract includes a two-step mechanism to transfer
* ownership, where the new owner must call {acceptOwnership} in order to replace the
* old one. This can help prevent common mistakes, such as transfers of ownership to
* incorrect accounts, or to contracts that are unable to interact with the
* permission system.
*
* The initial owner is specified at deployment time in the constructor for `Ownable`. This
* can later be changed with {transferOwnership} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2StepUpgradeable is Initializable, OwnableUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Ownable2Step
struct Ownable2StepStorage {
address _pendingOwner;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable2Step")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant Ownable2StepStorageLocation = 0x237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00;
function _getOwnable2StepStorage() private pure returns (Ownable2StepStorage storage $) {
assembly {
$.slot := Ownable2StepStorageLocation
}
}
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
function __Ownable2Step_init() internal onlyInitializing {
}
function __Ownable2Step_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
Ownable2StepStorage storage $ = _getOwnable2StepStorage();
return $._pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*
* Setting `newOwner` to the zero address is allowed; this can be used to cancel an initiated ownership transfer.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
Ownable2StepStorage storage $ = _getOwnable2StepStorage();
$._pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
Ownable2StepStorage storage $ = _getOwnable2StepStorage();
delete $._pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() public virtual {
address sender = _msgSender();
if (pendingOwner() != sender) {
revert OwnableUnauthorizedAccount(sender);
}
_transferOwnership(sender);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuardUpgradeable is Initializable {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
/// @custom:storage-location erc7201:openzeppelin.storage.ReentrancyGuard
struct ReentrancyGuardStorage {
uint256 _status;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ReentrancyGuardStorageLocation = 0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;
function _getReentrancyGuardStorage() private pure returns (ReentrancyGuardStorage storage $) {
assembly {
$.slot := ReentrancyGuardStorageLocation
}
}
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
$._status = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// On the first call to nonReentrant, _status will be NOT_ENTERED
if ($._status == ENTERED) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
$._status = ENTERED;
}
function _nonReentrantAfter() private {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
$._status = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
return $._status == ENTERED;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.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 {
_callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*
* 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 {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev 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 rely 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 rely 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}.
* Opposedly, 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 high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/IERC20Metadata.sol)
pragma solidity ^0.8.20;
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
// OpenZeppelin Contracts (last updated v5.1.0) (utils/math/Math.sol)
pragma solidity ^0.8.20;
import {Panic} from "../Panic.sol";
import {SafeCast} from "./SafeCast.sol";
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
enum Rounding {
Floor, // Toward negative infinity
Ceil, // Toward positive infinity
Trunc, // Toward zero
Expand // Away from zero
}
/**
* @dev Returns the addition of two unsigned integers, with an success flag (no overflow).
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the subtraction of two unsigned integers, with an success flag (no overflow).
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b > a) return (false, 0);
return (true, a - b);
}
}
/**
* @dev Returns the multiplication of two unsigned integers, with an success flag (no overflow).
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
}
/**
* @dev Returns the division of two unsigned integers, with a success flag (no division by zero).
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b == 0) return (false, 0);
return (true, a / b);
}
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a success flag (no division by zero).
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool success, uint256 result) {
unchecked {
if (b == 0) return (false, 0);
return (true, a % b);
}
}
/**
* @dev Branchless ternary evaluation for `a ? b : c`. Gas costs are constant.
*
* IMPORTANT: This function may reduce bytecode size and consume less gas when used standalone.
* However, the compiler may optimize Solidity ternary operations (i.e. `a ? b : c`) to only compute
* one branch when needed, making this function more expensive.
*/
function ternary(bool condition, uint256 a, uint256 b) internal pure returns (uint256) {
unchecked {
// branchless ternary works because:
// b ^ (a ^ b) == a
// b ^ 0 == b
return b ^ ((a ^ b) * SafeCast.toUint(condition));
}
}
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a > b, a, b);
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return ternary(a < b, a, b);
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow.
return (a & b) + (a ^ b) / 2;
}
/**
* @dev Returns the ceiling of the division of two numbers.
*
* This differs from standard division with `/` in that it rounds towards infinity instead
* of rounding towards zero.
*/
function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) {
if (b == 0) {
// Guarantee the same behavior as in a regular Solidity division.
Panic.panic(Panic.DIVISION_BY_ZERO);
}
// The following calculation ensures accurate ceiling division without overflow.
// Since a is non-zero, (a - 1) / b will not overflow.
// The largest possible result occurs when (a - 1) / b is type(uint256).max,
// but the largest value we can obtain is type(uint256).max - 1, which happens
// when a = type(uint256).max and b = 1.
unchecked {
return SafeCast.toUint(a > 0) * ((a - 1) / b + 1);
}
}
/**
* @dev Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or
* denominator == 0.
*
* Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) with further edits by
* Uniswap Labs also under MIT license.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) {
unchecked {
// 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2²⁵⁶ and mod 2²⁵⁶ - 1, then use
// the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2²⁵⁶ + prod0.
uint256 prod0 = x * y; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(x, y, not(0))
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division.
if (prod1 == 0) {
// Solidity will revert if denominator == 0, unlike the div opcode on its own.
// The surrounding unchecked block does not change this fact.
// See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic.
return prod0 / denominator;
}
// Make sure the result is less than 2²⁵⁶. Also prevents denominator == 0.
if (denominator <= prod1) {
Panic.panic(ternary(denominator == 0, Panic.DIVISION_BY_ZERO, Panic.UNDER_OVERFLOW));
}
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0].
uint256 remainder;
assembly {
// Compute remainder using mulmod.
remainder := mulmod(x, y, denominator)
// Subtract 256 bit number from 512 bit number.
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator and compute largest power of two divisor of denominator.
// Always >= 1. See https://cs.stackexchange.com/q/138556/92363.
uint256 twos = denominator & (0 - denominator);
assembly {
// Divide denominator by twos.
denominator := div(denominator, twos)
// Divide [prod1 prod0] by twos.
prod0 := div(prod0, twos)
// Flip twos such that it is 2²⁵⁶ / twos. If twos is zero, then it becomes one.
twos := add(div(sub(0, twos), twos), 1)
}
// Shift in bits from prod1 into prod0.
prod0 |= prod1 * twos;
// Invert denominator mod 2²⁵⁶. Now that denominator is an odd number, it has an inverse modulo 2²⁵⁶ such
// that denominator * inv ≡ 1 mod 2²⁵⁶. Compute the inverse by starting with a seed that is correct for
// four bits. That is, denominator * inv ≡ 1 mod 2⁴.
uint256 inverse = (3 * denominator) ^ 2;
// Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also
// works in modular arithmetic, doubling the correct bits in each step.
inverse *= 2 - denominator * inverse; // inverse mod 2⁸
inverse *= 2 - denominator * inverse; // inverse mod 2¹⁶
inverse *= 2 - denominator * inverse; // inverse mod 2³²
inverse *= 2 - denominator * inverse; // inverse mod 2⁶⁴
inverse *= 2 - denominator * inverse; // inverse mod 2¹²⁸
inverse *= 2 - denominator * inverse; // inverse mod 2²⁵⁶
// Because the division is now exact we can divide by multiplying with the modular inverse of denominator.
// This will give us the correct result modulo 2²⁵⁶. Since the preconditions guarantee that the outcome is
// less than 2²⁵⁶, this is the final result. We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inverse;
return result;
}
}
/**
* @dev Calculates x * y / denominator with full precision, following the selected rounding direction.
*/
function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) {
return mulDiv(x, y, denominator) + SafeCast.toUint(unsignedRoundsUp(rounding) && mulmod(x, y, denominator) > 0);
}
/**
* @dev Calculate the modular multiplicative inverse of a number in Z/nZ.
*
* If n is a prime, then Z/nZ is a field. In that case all elements are inversible, except 0.
* If n is not a prime, then Z/nZ is not a field, and some elements might not be inversible.
*
* If the input value is not inversible, 0 is returned.
*
* NOTE: If you know for sure that n is (big) a prime, it may be cheaper to use Fermat's little theorem and get the
* inverse using `Math.modExp(a, n - 2, n)`. See {invModPrime}.
*/
function invMod(uint256 a, uint256 n) internal pure returns (uint256) {
unchecked {
if (n == 0) return 0;
// The inverse modulo is calculated using the Extended Euclidean Algorithm (iterative version)
// Used to compute integers x and y such that: ax + ny = gcd(a, n).
// When the gcd is 1, then the inverse of a modulo n exists and it's x.
// ax + ny = 1
// ax = 1 + (-y)n
// ax ≡ 1 (mod n) # x is the inverse of a modulo n
// If the remainder is 0 the gcd is n right away.
uint256 remainder = a % n;
uint256 gcd = n;
// Therefore the initial coefficients are:
// ax + ny = gcd(a, n) = n
// 0a + 1n = n
int256 x = 0;
int256 y = 1;
while (remainder != 0) {
uint256 quotient = gcd / remainder;
(gcd, remainder) = (
// The old remainder is the next gcd to try.
remainder,
// Compute the next remainder.
// Can't overflow given that (a % gcd) * (gcd // (a % gcd)) <= gcd
// where gcd is at most n (capped to type(uint256).max)
gcd - remainder * quotient
);
(x, y) = (
// Increment the coefficient of a.
y,
// Decrement the coefficient of n.
// Can overflow, but the result is casted to uint256 so that the
// next value of y is "wrapped around" to a value between 0 and n - 1.
x - y * int256(quotient)
);
}
if (gcd != 1) return 0; // No inverse exists.
return ternary(x < 0, n - uint256(-x), uint256(x)); // Wrap the result if it's negative.
}
}
/**
* @dev Variant of {invMod}. More efficient, but only works if `p` is known to be a prime greater than `2`.
*
* From https://en.wikipedia.org/wiki/Fermat%27s_little_theorem[Fermat's little theorem], we know that if p is
* prime, then `a**(p-1) ≡ 1 mod p`. As a consequence, we have `a * a**(p-2) ≡ 1 mod p`, which means that
* `a**(p-2)` is the modular multiplicative inverse of a in Fp.
*
* NOTE: this function does NOT check that `p` is a prime greater than `2`.
*/
function invModPrime(uint256 a, uint256 p) internal view returns (uint256) {
unchecked {
return Math.modExp(a, p - 2, p);
}
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m)
*
* Requirements:
* - modulus can't be zero
* - underlying staticcall to precompile must succeed
*
* IMPORTANT: The result is only valid if the underlying call succeeds. When using this function, make
* sure the chain you're using it on supports the precompiled contract for modular exponentiation
* at address 0x05 as specified in https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise,
* the underlying function will succeed given the lack of a revert, but the result may be incorrectly
* interpreted as 0.
*/
function modExp(uint256 b, uint256 e, uint256 m) internal view returns (uint256) {
(bool success, uint256 result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Returns the modular exponentiation of the specified base, exponent and modulus (b ** e % m).
* It includes a success flag indicating if the operation succeeded. Operation will be marked as failed if trying
* to operate modulo 0 or if the underlying precompile reverted.
*
* IMPORTANT: The result is only valid if the success flag is true. When using this function, make sure the chain
* you're using it on supports the precompiled contract for modular exponentiation at address 0x05 as specified in
* https://eips.ethereum.org/EIPS/eip-198[EIP-198]. Otherwise, the underlying function will succeed given the lack
* of a revert, but the result may be incorrectly interpreted as 0.
*/
function tryModExp(uint256 b, uint256 e, uint256 m) internal view returns (bool success, uint256 result) {
if (m == 0) return (false, 0);
assembly ("memory-safe") {
let ptr := mload(0x40)
// | Offset | Content | Content (Hex) |
// |-----------|------------|--------------------------------------------------------------------|
// | 0x00:0x1f | size of b | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x20:0x3f | size of e | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x40:0x5f | size of m | 0x0000000000000000000000000000000000000000000000000000000000000020 |
// | 0x60:0x7f | value of b | 0x<.............................................................b> |
// | 0x80:0x9f | value of e | 0x<.............................................................e> |
// | 0xa0:0xbf | value of m | 0x<.............................................................m> |
mstore(ptr, 0x20)
mstore(add(ptr, 0x20), 0x20)
mstore(add(ptr, 0x40), 0x20)
mstore(add(ptr, 0x60), b)
mstore(add(ptr, 0x80), e)
mstore(add(ptr, 0xa0), m)
// Given the result < m, it's guaranteed to fit in 32 bytes,
// so we can use the memory scratch space located at offset 0.
success := staticcall(gas(), 0x05, ptr, 0xc0, 0x00, 0x20)
result := mload(0x00)
}
}
/**
* @dev Variant of {modExp} that supports inputs of arbitrary length.
*/
function modExp(bytes memory b, bytes memory e, bytes memory m) internal view returns (bytes memory) {
(bool success, bytes memory result) = tryModExp(b, e, m);
if (!success) {
Panic.panic(Panic.DIVISION_BY_ZERO);
}
return result;
}
/**
* @dev Variant of {tryModExp} that supports inputs of arbitrary length.
*/
function tryModExp(
bytes memory b,
bytes memory e,
bytes memory m
) internal view returns (bool success, bytes memory result) {
if (_zeroBytes(m)) return (false, new bytes(0));
uint256 mLen = m.length;
// Encode call args in result and move the free memory pointer
result = abi.encodePacked(b.length, e.length, mLen, b, e, m);
assembly ("memory-safe") {
let dataPtr := add(result, 0x20)
// Write result on top of args to avoid allocating extra memory.
success := staticcall(gas(), 0x05, dataPtr, mload(result), dataPtr, mLen)
// Overwrite the length.
// result.length > returndatasize() is guaranteed because returndatasize() == m.length
mstore(result, mLen)
// Set the memory pointer after the returned data.
mstore(0x40, add(dataPtr, mLen))
}
}
/**
* @dev Returns whether the provided byte array is zero.
*/
function _zeroBytes(bytes memory byteArray) private pure returns (bool) {
for (uint256 i = 0; i < byteArray.length; ++i) {
if (byteArray[i] != 0) {
return false;
}
}
return true;
}
/**
* @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded
* towards zero.
*
* This method is based on Newton's method for computing square roots; the algorithm is restricted to only
* using integer operations.
*/
function sqrt(uint256 a) internal pure returns (uint256) {
unchecked {
// Take care of easy edge cases when a == 0 or a == 1
if (a <= 1) {
return a;
}
// In this function, we use Newton's method to get a root of `f(x) := x² - a`. It involves building a
// sequence x_n that converges toward sqrt(a). For each iteration x_n, we also define the error between
// the current value as `ε_n = | x_n - sqrt(a) |`.
//
// For our first estimation, we consider `e` the smallest power of 2 which is bigger than the square root
// of the target. (i.e. `2**(e-1) ≤ sqrt(a) < 2**e`). We know that `e ≤ 128` because `(2¹²⁸)² = 2²⁵⁶` is
// bigger than any uint256.
//
// By noticing that
// `2**(e-1) ≤ sqrt(a) < 2**e → (2**(e-1))² ≤ a < (2**e)² → 2**(2*e-2) ≤ a < 2**(2*e)`
// we can deduce that `e - 1` is `log2(a) / 2`. We can thus compute `x_n = 2**(e-1)` using a method similar
// to the msb function.
uint256 aa = a;
uint256 xn = 1;
if (aa >= (1 << 128)) {
aa >>= 128;
xn <<= 64;
}
if (aa >= (1 << 64)) {
aa >>= 64;
xn <<= 32;
}
if (aa >= (1 << 32)) {
aa >>= 32;
xn <<= 16;
}
if (aa >= (1 << 16)) {
aa >>= 16;
xn <<= 8;
}
if (aa >= (1 << 8)) {
aa >>= 8;
xn <<= 4;
}
if (aa >= (1 << 4)) {
aa >>= 4;
xn <<= 2;
}
if (aa >= (1 << 2)) {
xn <<= 1;
}
// We now have x_n such that `x_n = 2**(e-1) ≤ sqrt(a) < 2**e = 2 * x_n`. This implies ε_n ≤ 2**(e-1).
//
// We can refine our estimation by noticing that the middle of that interval minimizes the error.
// If we move x_n to equal 2**(e-1) + 2**(e-2), then we reduce the error to ε_n ≤ 2**(e-2).
// This is going to be our x_0 (and ε_0)
xn = (3 * xn) >> 1; // ε_0 := | x_0 - sqrt(a) | ≤ 2**(e-2)
// From here, Newton's method give us:
// x_{n+1} = (x_n + a / x_n) / 2
//
// One should note that:
// x_{n+1}² - a = ((x_n + a / x_n) / 2)² - a
// = ((x_n² + a) / (2 * x_n))² - a
// = (x_n⁴ + 2 * a * x_n² + a²) / (4 * x_n²) - a
// = (x_n⁴ + 2 * a * x_n² + a² - 4 * a * x_n²) / (4 * x_n²)
// = (x_n⁴ - 2 * a * x_n² + a²) / (4 * x_n²)
// = (x_n² - a)² / (2 * x_n)²
// = ((x_n² - a) / (2 * x_n))²
// ≥ 0
// Which proves that for all n ≥ 1, sqrt(a) ≤ x_n
//
// This gives us the proof of quadratic convergence of the sequence:
// ε_{n+1} = | x_{n+1} - sqrt(a) |
// = | (x_n + a / x_n) / 2 - sqrt(a) |
// = | (x_n² + a - 2*x_n*sqrt(a)) / (2 * x_n) |
// = | (x_n - sqrt(a))² / (2 * x_n) |
// = | ε_n² / (2 * x_n) |
// = ε_n² / | (2 * x_n) |
//
// For the first iteration, we have a special case where x_0 is known:
// ε_1 = ε_0² / | (2 * x_0) |
// ≤ (2**(e-2))² / (2 * (2**(e-1) + 2**(e-2)))
// ≤ 2**(2*e-4) / (3 * 2**(e-1))
// ≤ 2**(e-3) / 3
// ≤ 2**(e-3-log2(3))
// ≤ 2**(e-4.5)
//
// For the following iterations, we use the fact that, 2**(e-1) ≤ sqrt(a) ≤ x_n:
// ε_{n+1} = ε_n² / | (2 * x_n) |
// ≤ (2**(e-k))² / (2 * 2**(e-1))
// ≤ 2**(2*e-2*k) / 2**e
// ≤ 2**(e-2*k)
xn = (xn + a / xn) >> 1; // ε_1 := | x_1 - sqrt(a) | ≤ 2**(e-4.5) -- special case, see above
xn = (xn + a / xn) >> 1; // ε_2 := | x_2 - sqrt(a) | ≤ 2**(e-9) -- general case with k = 4.5
xn = (xn + a / xn) >> 1; // ε_3 := | x_3 - sqrt(a) | ≤ 2**(e-18) -- general case with k = 9
xn = (xn + a / xn) >> 1; // ε_4 := | x_4 - sqrt(a) | ≤ 2**(e-36) -- general case with k = 18
xn = (xn + a / xn) >> 1; // ε_5 := | x_5 - sqrt(a) | ≤ 2**(e-72) -- general case with k = 36
xn = (xn + a / xn) >> 1; // ε_6 := | x_6 - sqrt(a) | ≤ 2**(e-144) -- general case with k = 72
// Because e ≤ 128 (as discussed during the first estimation phase), we know have reached a precision
// ε_6 ≤ 2**(e-144) < 1. Given we're operating on integers, then we can ensure that xn is now either
// sqrt(a) or sqrt(a) + 1.
return xn - SafeCast.toUint(xn > a / xn);
}
}
/**
* @dev Calculates sqrt(a), following the selected rounding direction.
*/
function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = sqrt(a);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && result * result < a);
}
}
/**
* @dev Return the log in base 2 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log2(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
uint256 exp;
unchecked {
exp = 128 * SafeCast.toUint(value > (1 << 128) - 1);
value >>= exp;
result += exp;
exp = 64 * SafeCast.toUint(value > (1 << 64) - 1);
value >>= exp;
result += exp;
exp = 32 * SafeCast.toUint(value > (1 << 32) - 1);
value >>= exp;
result += exp;
exp = 16 * SafeCast.toUint(value > (1 << 16) - 1);
value >>= exp;
result += exp;
exp = 8 * SafeCast.toUint(value > (1 << 8) - 1);
value >>= exp;
result += exp;
exp = 4 * SafeCast.toUint(value > (1 << 4) - 1);
value >>= exp;
result += exp;
exp = 2 * SafeCast.toUint(value > (1 << 2) - 1);
value >>= exp;
result += exp;
result += SafeCast.toUint(value > 1);
}
return result;
}
/**
* @dev Return the log in base 2, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log2(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log2(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << result < value);
}
}
/**
* @dev Return the log in base 10 of a positive value rounded towards zero.
* Returns 0 if given 0.
*/
function log10(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
unchecked {
if (value >= 10 ** 64) {
value /= 10 ** 64;
result += 64;
}
if (value >= 10 ** 32) {
value /= 10 ** 32;
result += 32;
}
if (value >= 10 ** 16) {
value /= 10 ** 16;
result += 16;
}
if (value >= 10 ** 8) {
value /= 10 ** 8;
result += 8;
}
if (value >= 10 ** 4) {
value /= 10 ** 4;
result += 4;
}
if (value >= 10 ** 2) {
value /= 10 ** 2;
result += 2;
}
if (value >= 10 ** 1) {
result += 1;
}
}
return result;
}
/**
* @dev Return the log in base 10, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log10(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log10(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 10 ** result < value);
}
}
/**
* @dev Return the log in base 256 of a positive value rounded towards zero.
* Returns 0 if given 0.
*
* Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string.
*/
function log256(uint256 value) internal pure returns (uint256) {
uint256 result = 0;
uint256 isGt;
unchecked {
isGt = SafeCast.toUint(value > (1 << 128) - 1);
value >>= isGt * 128;
result += isGt * 16;
isGt = SafeCast.toUint(value > (1 << 64) - 1);
value >>= isGt * 64;
result += isGt * 8;
isGt = SafeCast.toUint(value > (1 << 32) - 1);
value >>= isGt * 32;
result += isGt * 4;
isGt = SafeCast.toUint(value > (1 << 16) - 1);
value >>= isGt * 16;
result += isGt * 2;
result += SafeCast.toUint(value > (1 << 8) - 1);
}
return result;
}
/**
* @dev Return the log in base 256, following the selected rounding direction, of a positive value.
* Returns 0 if given 0.
*/
function log256(uint256 value, Rounding rounding) internal pure returns (uint256) {
unchecked {
uint256 result = log256(value);
return result + SafeCast.toUint(unsignedRoundsUp(rounding) && 1 << (result << 3) < value);
}
}
/**
* @dev Returns whether a provided rounding mode is considered rounding up for unsigned integers.
*/
function unsignedRoundsUp(Rounding rounding) internal pure returns (bool) {
return uint8(rounding) % 2 == 1;
}
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.28;
import {IHyperliquidCommon} from "@blueberry-v2/vaults/hyperliquid/interfaces/IHyperliquidCommon.sol";
/**
* @title IHyperVaultRouter
* @author Blueberry
*/
interface IHyperVaultRouter is IHyperliquidCommon {
/*//////////////////////////////////////////////////////////////
Events
//////////////////////////////////////////////////////////////*/
/// @notice Emitted when a user deposits to the vault
event Deposit(address indexed from, address indexed asset, uint256 amount, uint256 shares);
/// @notice Emitted when a user redeems from the vault
event Redeem(address indexed from, uint256 shares, uint256 amount);
/// @notice New Supported Asset Added
event AssetAdded(uint64 assetIndex, AssetDetails details);
/// @notice Emitted when a supported asset is removed
event AssetRemoved(uint64 assetIndex);
/// @notice Emitted when the withdraw asset is updated
event WithdrawAssetUpdated(uint64 assetIndex);
/*//////////////////////////////////////////////////////////////
External Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Deposit an asset into the escrows and mint shares of the tokenized vault
* @param asset The address of the asset to deposit
* @param amount The amount of asset to deposit
* @param minOut The minimum amount of shares to mint
* @return shares The amount of shares minted to the user
*/
function deposit(address asset, uint256 amount, uint256 minOut) external returns (uint256 shares);
/**
* @notice Redeems shares for the withdraw asset
* @param shares The amount of shares to redeem
* @param minOut The minimum amount of withdraw asset to receive
* @return amount The amount of withdraw asset received
*/
function redeem(uint256 shares, uint256 minOut) external returns (uint256 amount);
/*//////////////////////////////////////////////////////////////
View Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice The address of the share token for the tokenized vault
* @return The share token address
*/
function SHARE_TOKEN() external view returns (address);
/**
* @notice Returns the total value locked for all escrows in the vault
* @return tvl_ The total value locked
*/
function tvl() external view returns (uint256 tvl_);
/// @notice Returns the address of the escrow at the specified index
function escrows(uint256 index) external view returns (address);
/// @notice Returns the spot index of the asset
function assetIndex(address asset) external view returns (uint64);
/// @notice Returns the last fee collection timestamp
function lastFeeCollectionTimestamp() external view returns (uint256);
/// @notice The management fee in basis points
function managementFee() external view returns (uint256);
/// @notice The minimum value in USD that can be deposited into the vault scaled to 1e18
function minDeposit() external view returns (uint256);
/// @notice The asset that will be used to withdraw from the vault
function withdrawAsset() external view returns (address);
/// @notice The address that will receive the management fee
function feeRecipient() external view returns (address);
/**
* @notice Determines which escrow will receive deposits
* @dev The deposit escrow will be updated every 2 days.
* Should be noted that withdraws will occur from all escrows
* @return The index of the escrow that will receive deposits
*/
function depositEscrowIndex() external view returns (uint256);
/// @notice Returns the max number of withdrawable assets able to be withdrawn
function maxWithdrawable() external view returns (uint256);
/// @notice Returns the max number of shares able to be redeemed
function maxRedeemable() external view returns (uint256);
/// @notice Returns the amount of shares that will be minted for a given amount of asset
function previewDeposit(address asset, uint256 amount) external view returns (uint256 shares);
/// @notice Returns the amount of withdraw asset that will be received for a given amount of shares
function previewRedeem(uint256 shares) external view returns (uint256 amount);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (access/IAccessControl.sol)
pragma solidity ^0.8.20;
/**
* @dev External interface of AccessControl declared to support ERC-165 detection.
*/
interface IAccessControl {
/**
* @dev The `account` is missing a role.
*/
error AccessControlUnauthorizedAccount(address account, bytes32 neededRole);
/**
* @dev The caller of a function is not the expected one.
*
* NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
*/
error AccessControlBadConfirmation();
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call. This account bears the admin role (for the granted role).
* Expected in cases where the role was granted using the internal {AccessControl-_grantRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*/
function renounceRole(bytes32 role, address callerConfirmation) external;
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 tokens.
*/
interface IERC20Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC20InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC20InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
* @param spender Address that may be allowed to operate on tokens without being their owner.
* @param allowance Amount of tokens a `spender` is allowed to operate with.
* @param needed Minimum amount required to perform a transfer.
*/
error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC20InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `spender` to be approved. Used in approvals.
* @param spender Address that may be allowed to operate on tokens without being their owner.
*/
error ERC20InvalidSpender(address spender);
}
/**
* @dev Standard ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-20.
* Used in balance queries.
* @param owner Address of the current owner of a token.
*/
error ERC721InvalidOwner(address owner);
/**
* @dev Indicates a `tokenId` whose `owner` is the zero address.
* @param tokenId Identifier number of a token.
*/
error ERC721NonexistentToken(uint256 tokenId);
/**
* @dev Indicates an error related to the ownership over a particular token. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param tokenId Identifier number of a token.
* @param owner Address of the current owner of a token.
*/
error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC721InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC721InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param tokenId Identifier number of a token.
*/
error ERC721InsufficientApproval(address operator, uint256 tokenId);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC721InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC721InvalidOperator(address operator);
}
/**
* @dev Standard ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 tokens.
*/
interface IERC1155Errors {
/**
* @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
* @param balance Current balance for the interacting account.
* @param needed Minimum amount required to perform a transfer.
* @param tokenId Identifier number of a token.
*/
error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);
/**
* @dev Indicates a failure with the token `sender`. Used in transfers.
* @param sender Address whose tokens are being transferred.
*/
error ERC1155InvalidSender(address sender);
/**
* @dev Indicates a failure with the token `receiver`. Used in transfers.
* @param receiver Address to which tokens are being transferred.
*/
error ERC1155InvalidReceiver(address receiver);
/**
* @dev Indicates a failure with the `operator`’s approval. Used in transfers.
* @param operator Address that may be allowed to operate on tokens without being their owner.
* @param owner Address of the current owner of a token.
*/
error ERC1155MissingApprovalForAll(address operator, address owner);
/**
* @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
* @param approver Address initiating an approval operation.
*/
error ERC1155InvalidApprover(address approver);
/**
* @dev Indicates a failure with the `operator` to be approved. Used in approvals.
* @param operator Address that may be allowed to operate on tokens without being their owner.
*/
error ERC1155InvalidOperator(address operator);
/**
* @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
* Used in batch transfers.
* @param idsLength Length of the array of token identifiers
* @param valuesLength Length of the array of token amounts
*/
error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[ERC-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC-20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/ECDSA.sol)
pragma solidity ^0.8.20;
/**
* @dev Elliptic Curve Digital Signature Algorithm (ECDSA) operations.
*
* These functions can be used to verify that a message was signed by the holder
* of the private keys of a given address.
*/
library ECDSA {
enum RecoverError {
NoError,
InvalidSignature,
InvalidSignatureLength,
InvalidSignatureS
}
/**
* @dev The signature derives the `address(0)`.
*/
error ECDSAInvalidSignature();
/**
* @dev The signature has an invalid length.
*/
error ECDSAInvalidSignatureLength(uint256 length);
/**
* @dev The signature has an S value that is in the upper half order.
*/
error ECDSAInvalidSignatureS(bytes32 s);
/**
* @dev Returns the address that signed a hashed message (`hash`) with `signature` or an error. This will not
* return address(0) without also returning an error description. Errors are documented using an enum (error type)
* and a bytes32 providing additional information about the error.
*
* If no error is returned, then the address can be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*
* Documentation for signature generation:
* - with https://web3js.readthedocs.io/en/v1.3.4/web3-eth-accounts.html#sign[Web3.js]
* - with https://docs.ethers.io/v5/api/signer/#Signer-signMessage[ethers]
*/
function tryRecover(
bytes32 hash,
bytes memory signature
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
if (signature.length == 65) {
bytes32 r;
bytes32 s;
uint8 v;
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
assembly ("memory-safe") {
r := mload(add(signature, 0x20))
s := mload(add(signature, 0x40))
v := byte(0, mload(add(signature, 0x60)))
}
return tryRecover(hash, v, r, s);
} else {
return (address(0), RecoverError.InvalidSignatureLength, bytes32(signature.length));
}
}
/**
* @dev Returns the address that signed a hashed message (`hash`) with
* `signature`. This address can then be used for verification purposes.
*
* The `ecrecover` EVM precompile allows for malleable (non-unique) signatures:
* this function rejects them by requiring the `s` value to be in the lower
* half order, and the `v` value to be either 27 or 28.
*
* IMPORTANT: `hash` _must_ be the result of a hash operation for the
* verification to be secure: it is possible to craft signatures that
* recover to arbitrary addresses for non-hashed data. A safe way to ensure
* this is by receiving a hash of the original message (which may otherwise
* be too long), and then calling {MessageHashUtils-toEthSignedMessageHash} on it.
*/
function recover(bytes32 hash, bytes memory signature) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, signature);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `r` and `vs` short-signature fields separately.
*
* See https://eips.ethereum.org/EIPS/eip-2098[ERC-2098 short signatures]
*/
function tryRecover(
bytes32 hash,
bytes32 r,
bytes32 vs
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
unchecked {
bytes32 s = vs & bytes32(0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff);
// We do not check for an overflow here since the shift operation results in 0 or 1.
uint8 v = uint8((uint256(vs) >> 255) + 27);
return tryRecover(hash, v, r, s);
}
}
/**
* @dev Overload of {ECDSA-recover} that receives the `r and `vs` short-signature fields separately.
*/
function recover(bytes32 hash, bytes32 r, bytes32 vs) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, r, vs);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Overload of {ECDSA-tryRecover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function tryRecover(
bytes32 hash,
uint8 v,
bytes32 r,
bytes32 s
) internal pure returns (address recovered, RecoverError err, bytes32 errArg) {
// EIP-2 still allows signature malleability for ecrecover(). Remove this possibility and make the signature
// unique. Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines
// the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. Most
// signatures from current libraries generate a unique signature with an s-value in the lower half order.
//
// If your library generates malleable signatures, such as s-values in the upper range, calculate a new s-value
// with 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141 - s1 and flip v from 27 to 28 or
// vice versa. If your library also generates signatures with 0/1 for v instead 27/28, add 27 to v to accept
// these malleable signatures as well.
if (uint256(s) > 0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) {
return (address(0), RecoverError.InvalidSignatureS, s);
}
// If the signature is valid (and not malleable), return the signer address
address signer = ecrecover(hash, v, r, s);
if (signer == address(0)) {
return (address(0), RecoverError.InvalidSignature, bytes32(0));
}
return (signer, RecoverError.NoError, bytes32(0));
}
/**
* @dev Overload of {ECDSA-recover} that receives the `v`,
* `r` and `s` signature fields separately.
*/
function recover(bytes32 hash, uint8 v, bytes32 r, bytes32 s) internal pure returns (address) {
(address recovered, RecoverError error, bytes32 errorArg) = tryRecover(hash, v, r, s);
_throwError(error, errorArg);
return recovered;
}
/**
* @dev Optionally reverts with the corresponding custom error according to the `error` argument provided.
*/
function _throwError(RecoverError error, bytes32 errorArg) private pure {
if (error == RecoverError.NoError) {
return; // no error: do nothing
} else if (error == RecoverError.InvalidSignature) {
revert ECDSAInvalidSignature();
} else if (error == RecoverError.InvalidSignatureLength) {
revert ECDSAInvalidSignatureLength(uint256(errorArg));
} else if (error == RecoverError.InvalidSignatureS) {
revert ECDSAInvalidSignatureS(errorArg);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/EIP712.sol)
pragma solidity ^0.8.20;
import {MessageHashUtils} from "./MessageHashUtils.sol";
import {ShortStrings, ShortString} from "../ShortStrings.sol";
import {IERC5267} from "../../interfaces/IERC5267.sol";
/**
* @dev https://eips.ethereum.org/EIPS/eip-712[EIP-712] is a standard for hashing and signing of typed structured data.
*
* The encoding scheme specified in the EIP requires a domain separator and a hash of the typed structured data, whose
* encoding is very generic and therefore its implementation in Solidity is not feasible, thus this contract
* does not implement the encoding itself. Protocols need to implement the type-specific encoding they need in order to
* produce the hash of their typed data using a combination of `abi.encode` and `keccak256`.
*
* This contract implements the EIP-712 domain separator ({_domainSeparatorV4}) that is used as part of the encoding
* scheme, and the final step of the encoding to obtain the message digest that is then signed via ECDSA
* ({_hashTypedDataV4}).
*
* The implementation of the domain separator was designed to be as efficient as possible while still properly updating
* the chain id to protect against replay attacks on an eventual fork of the chain.
*
* NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method
* https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask].
*
* NOTE: In the upgradeable version of this contract, the cached values will correspond to the address, and the domain
* separator of the implementation contract. This will cause the {_domainSeparatorV4} function to always rebuild the
* separator from the immutable values, which is cheaper than accessing a cached version in cold storage.
*
* @custom:oz-upgrades-unsafe-allow state-variable-immutable
*/
abstract contract EIP712 is IERC5267 {
using ShortStrings for *;
bytes32 private constant TYPE_HASH =
keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)");
// Cache the domain separator as an immutable value, but also store the chain id that it corresponds to, in order to
// invalidate the cached domain separator if the chain id changes.
bytes32 private immutable _cachedDomainSeparator;
uint256 private immutable _cachedChainId;
address private immutable _cachedThis;
bytes32 private immutable _hashedName;
bytes32 private immutable _hashedVersion;
ShortString private immutable _name;
ShortString private immutable _version;
string private _nameFallback;
string private _versionFallback;
/**
* @dev Initializes the domain separator and parameter caches.
*
* The meaning of `name` and `version` is specified in
* https://eips.ethereum.org/EIPS/eip-712#definition-of-domainseparator[EIP-712]:
*
* - `name`: the user readable name of the signing domain, i.e. the name of the DApp or the protocol.
* - `version`: the current major version of the signing domain.
*
* NOTE: These parameters cannot be changed except through a xref:learn::upgrading-smart-contracts.adoc[smart
* contract upgrade].
*/
constructor(string memory name, string memory version) {
_name = name.toShortStringWithFallback(_nameFallback);
_version = version.toShortStringWithFallback(_versionFallback);
_hashedName = keccak256(bytes(name));
_hashedVersion = keccak256(bytes(version));
_cachedChainId = block.chainid;
_cachedDomainSeparator = _buildDomainSeparator();
_cachedThis = address(this);
}
/**
* @dev Returns the domain separator for the current chain.
*/
function _domainSeparatorV4() internal view returns (bytes32) {
if (address(this) == _cachedThis && block.chainid == _cachedChainId) {
return _cachedDomainSeparator;
} else {
return _buildDomainSeparator();
}
}
function _buildDomainSeparator() private view returns (bytes32) {
return keccak256(abi.encode(TYPE_HASH, _hashedName, _hashedVersion, block.chainid, address(this)));
}
/**
* @dev Given an already https://eips.ethereum.org/EIPS/eip-712#definition-of-hashstruct[hashed struct], this
* function returns the hash of the fully encoded EIP712 message for this domain.
*
* This hash can be used together with {ECDSA-recover} to obtain the signer of a message. For example:
*
* ```solidity
* bytes32 digest = _hashTypedDataV4(keccak256(abi.encode(
* keccak256("Mail(address to,string contents)"),
* mailTo,
* keccak256(bytes(mailContents))
* )));
* address signer = ECDSA.recover(digest, signature);
* ```
*/
function _hashTypedDataV4(bytes32 structHash) internal view virtual returns (bytes32) {
return MessageHashUtils.toTypedDataHash(_domainSeparatorV4(), structHash);
}
/**
* @dev See {IERC-5267}.
*/
function eip712Domain()
public
view
virtual
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
)
{
return (
hex"0f", // 01111
_EIP712Name(),
_EIP712Version(),
block.chainid,
address(this),
bytes32(0),
new uint256[](0)
);
}
/**
* @dev The name parameter for the EIP712 domain.
*
* NOTE: By default this function reads _name which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Name() internal view returns (string memory) {
return _name.toStringWithFallback(_nameFallback);
}
/**
* @dev The version parameter for the EIP712 domain.
*
* NOTE: By default this function reads _version which is an immutable value.
* It only reads from storage if necessary (in case the value is too large to fit in a ShortString).
*/
// solhint-disable-next-line func-name-mixedcase
function _EIP712Version() internal view returns (string memory) {
return _version.toStringWithFallback(_versionFallback);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Nonces.sol)
pragma solidity ^0.8.20;
/**
* @dev Provides tracking nonces for addresses. Nonces will only increment.
*/
abstract contract Nonces {
/**
* @dev The nonce used for an `account` is not the expected current nonce.
*/
error InvalidAccountNonce(address account, uint256 currentNonce);
mapping(address account => uint256) private _nonces;
/**
* @dev Returns the next unused nonce for an address.
*/
function nonces(address owner) public view virtual returns (uint256) {
return _nonces[owner];
}
/**
* @dev Consumes a nonce.
*
* Returns the current value and increments nonce.
*/
function _useNonce(address owner) internal virtual returns (uint256) {
// For each account, the nonce has an initial value of 0, can only be incremented by one, and cannot be
// decremented or reset. This guarantees that the nonce never overflows.
unchecked {
// It is important to do x++ and not ++x here.
return _nonces[owner]++;
}
}
/**
* @dev Same as {_useNonce} but checking that `nonce` is the next valid for `owner`.
*/
function _useCheckedNonce(address owner, uint256 nonce) internal virtual {
uint256 current = _useNonce(owner);
if (nonce != current) {
revert InvalidAccountNonce(owner, current);
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/AccessControl.sol)
pragma solidity ^0.8.20;
import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {ERC165Upgradeable} from "../utils/introspection/ERC165Upgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```solidity
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```solidity
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControl, ERC165Upgradeable {
struct RoleData {
mapping(address account => bool) hasRole;
bytes32 adminRole;
}
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/// @custom:storage-location erc7201:openzeppelin.storage.AccessControl
struct AccessControlStorage {
mapping(bytes32 role => RoleData) _roles;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.AccessControl")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant AccessControlStorageLocation = 0x02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800;
function _getAccessControlStorage() private pure returns (AccessControlStorage storage $) {
assembly {
$.slot := AccessControlStorageLocation
}
}
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with an {AccessControlUnauthorizedAccount} error including the required role.
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
function __AccessControl_init() internal onlyInitializing {
}
function __AccessControl_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
return $._roles[role].hasRole[account];
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
* is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
* is missing `role`.
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert AccessControlUnauthorizedAccount(account, role);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
AccessControlStorage storage $ = _getAccessControlStorage();
return $._roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleGranted} event.
*/
function grantRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleRevoked} event.
*/
function revokeRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address callerConfirmation) public virtual {
if (callerConfirmation != _msgSender()) {
revert AccessControlBadConfirmation();
}
_revokeRole(role, callerConfirmation);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
AccessControlStorage storage $ = _getAccessControlStorage();
bytes32 previousAdminRole = getRoleAdmin(role);
$._roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (!hasRole(role, account)) {
$._roles[role].hasRole[account] = true;
emit RoleGranted(role, account, _msgSender());
return true;
} else {
return false;
}
}
/**
* @dev Attempts to revoke `role` to `account` and returns a boolean indicating if `role` was revoked.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (hasRole(role, account)) {
$._roles[role].hasRole[account] = false;
emit RoleRevoked(role, account, _msgSender());
return true;
} else {
return false;
}
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.28;
import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import {BlueberryErrors as Errors} from "@blueberry-v2/helpers/BlueberryErrors.sol";
import {IHyperliquidCommon} from "@blueberry-v2/vaults/hyperliquid/interfaces/IHyperliquidCommon.sol";
/**
* @title EscrowAssetStorage
* @author Blueberry
* @notice A storage contract for tracking the assets supported by an escrow
*/
abstract contract EscrowAssetStorage is IHyperliquidCommon {
using EnumerableSet for EnumerableSet.UintSet;
using SafeERC20 for IERC20;
/// @custom:storage-location erc7201:asset.v1.storage
struct V1AssetStorage {
/// @notice A set of supported asset indexes
EnumerableSet.UintSet supportedAssets;
/// @notice A mapping of asset Indexes to their corresponding asset details
mapping(uint64 => AssetDetails) assetDetails;
}
/*//////////////////////////////////////////////////////////////
Constants & Immutables
//////////////////////////////////////////////////////////////*/
/// @notice The address of the router contract
address public immutable ROUTER;
/// @notice The location for the escrow asset storage
bytes32 public constant V1_ASSET_STORAGE_LOCATION =
keccak256(abi.encode(uint256(keccak256(bytes("asset.v1.storage"))) - 1)) & ~bytes32(uint256(0xff));
/*//////////////////////////////////////////////////////////////
Modifiers
//////////////////////////////////////////////////////////////*/
modifier onlyRouter() {
require(msg.sender == ROUTER, Errors.INVALID_SENDER());
_;
}
/*//////////////////////////////////////////////////////////////
Constructor
//////////////////////////////////////////////////////////////*/
constructor(address router) {
ROUTER = router;
}
/*//////////////////////////////////////////////////////////////
Router Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Adds a new asset to the escrow
* @dev Only the vault router contract can call this function
* @param assetIndex The spot index of the asset to add
*/
function addAsset(uint32 assetIndex, AssetDetails memory details) external onlyRouter {
V1AssetStorage storage $ = _getV1AssetStorage();
require($.supportedAssets.length() < 5, Errors.ASSET_LIMIT_EXCEEDED());
require(!$.supportedAssets.contains(assetIndex), Errors.ASSET_ALREADY_SUPPORTED());
// Add the asset to the set of supported assets
$.supportedAssets.add(assetIndex);
$.assetDetails[assetIndex] = details;
}
/**
* @notice Removes a new asset to the escrow
* @dev Only the vault router contract can call this function
* @dev The contract, spot & inflight balances must be zero before removing
* @param assetIndex The spot index of the asset to remove
*/
function removeAsset(uint64 assetIndex) external onlyRouter {
V1AssetStorage storage $ = _getV1AssetStorage();
require($.supportedAssets.length() >= 2, Errors.INVALID_OPERATION());
require($.supportedAssets.contains(assetIndex), Errors.COLLATERAL_NOT_SUPPORTED());
// Make sure the contract, spot, & inflight balances are zero before removing
AssetDetails memory details = $.assetDetails[assetIndex];
uint256 assetBalance = IERC20(details.evmContract).balanceOf(address(this));
require(assetBalance == 0, Errors.INSUFFICIENT_BALANCE());
require(_spotAssetBalance(assetIndex) == 0, Errors.INSUFFICIENT_BALANCE());
require(_inflightBalance(assetIndex) == 0, Errors.INSUFFICIENT_BALANCE());
// Remove the asset from the set of supported assets
$.supportedAssets.remove(assetIndex);
delete $.assetDetails[assetIndex];
}
/**
* @notice Transfers funds from the escrow to the recipient
* @param asset The address of the asset to transfer
* @param recipient The address of the recipient
* @param amount The amount of funds to transfer
*/
function transferFunds(address asset, address recipient, uint256 amount) external onlyRouter {
IERC20(asset).safeTransfer(recipient, amount);
}
/*//////////////////////////////////////////////////////////////
View Functions
//////////////////////////////////////////////////////////////*/
/// @inheritdoc IHyperliquidCommon
function isAssetSupported(uint64 assetIndex) public view override returns (bool) {
V1AssetStorage storage $ = _getV1AssetStorage();
return $.supportedAssets.contains(assetIndex);
}
/// @inheritdoc IHyperliquidCommon
function assetDetails(uint64 assetIndex) external view override returns (AssetDetails memory) {
V1AssetStorage storage $ = _getV1AssetStorage();
return $.assetDetails[assetIndex];
}
/*//////////////////////////////////////////////////////////////
Pure Functions
//////////////////////////////////////////////////////////////*/
/// @notice Returns the storage location for the asset storage
function _getV1AssetStorage() internal pure returns (V1AssetStorage storage $) {
bytes32 slot = V1_ASSET_STORAGE_LOCATION;
assembly {
$.slot := slot
}
}
/**
* @notice Returns the spot asset balance
* @param assetIndex The spot index of the asset to get the balance of
* @return The spot asset balance
*/
function _spotAssetBalance(uint64 assetIndex) internal view virtual returns (uint256);
/**
* @notice Returns the current balance of an asset that is in-flight to L1
* @param assetIndex The asset index to check
*/
function _inflightBalance(uint64 assetIndex) internal view virtual returns (uint256);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @title ICoreWriter
* @notice An interface for sending transactions to the HyperLiquid L1.
*/
interface ICoreWriter {
function sendRawAction(bytes calldata data) external;
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.28;
/**
* @title IHyperliquidCommon
* @author Blueberry
* @notice A common interface for Hyperliquid contracts
*/
interface IHyperliquidCommon {
/*//////////////////////////////////////////////////////////////
Structs
//////////////////////////////////////////////////////////////*/
/// @notice Hyperliquid precompile struct: Token information
struct TokenInfo {
string name;
uint64[] spots;
uint64 deployerTradingFeeShare;
address deployer;
address evmContract;
uint8 szDecimals;
uint8 weiDecimals;
int8 evmExtraWeiDecimals;
}
/// @notice Hyperliquid precompile struct: Spot information for a specific pair
struct SpotInfo {
string name;
uint64[2] tokens;
}
/// @notice Necessary Hyperliquid core & evm information for a token index
struct AssetDetails {
address evmContract;
uint8 szDecimals;
uint8 weiDecimals;
uint8 evmDecimals;
uint32 spotMarket;
}
/*//////////////////////////////////////////////////////////////
View Functions
//////////////////////////////////////////////////////////////*/
/**
* @notice Returns whether an asset is supported by the escrow
* @param assetIndex The index of the asset to check
* @return Whether the asset is supported
*/
function isAssetSupported(uint64 assetIndex) external view returns (bool);
/**
* @notice Returns the details of an asset
* @param assetIndex The index of the asset to get details for
* @return The details of the asset as an AssetDetails struct
*/
function assetDetails(uint64 assetIndex) external view returns (AssetDetails memory);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* The initial owner is set to the address provided by the deployer. This can
* later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Ownable
struct OwnableStorage {
address _owner;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant OwnableStorageLocation = 0x9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300;
function _getOwnableStorage() private pure returns (OwnableStorage storage $) {
assembly {
$.slot := OwnableStorageLocation
}
}
/**
* @dev The caller account is not authorized to perform an operation.
*/
error OwnableUnauthorizedAccount(address account);
/**
* @dev The owner is not a valid owner account. (eg. `address(0)`)
*/
error OwnableInvalidOwner(address owner);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the address provided by the deployer as the initial owner.
*/
function __Ownable_init(address initialOwner) internal onlyInitializing {
__Ownable_init_unchained(initialOwner);
}
function __Ownable_init_unchained(address initialOwner) internal onlyInitializing {
if (initialOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(initialOwner);
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
OwnableStorage storage $ = _getOwnableStorage();
return $._owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
if (owner() != _msgSender()) {
revert OwnableUnauthorizedAccount(_msgSender());
}
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby disabling any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
if (newOwner == address(0)) {
revert OwnableInvalidOwner(address(0));
}
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
OwnableStorage storage $ = _getOwnableStorage();
address oldOwner = $._owner;
$._owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.20;
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Storage of the initializable contract.
*
* It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
* when using with upgradeable contracts.
*
* @custom:storage-location erc7201:openzeppelin.storage.Initializable
*/
struct InitializableStorage {
/**
* @dev Indicates that the contract has been initialized.
*/
uint64 _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool _initializing;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;
/**
* @dev The contract is already initialized.
*/
error InvalidInitialization();
/**
* @dev The contract is not initializing.
*/
error NotInitializing();
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint64 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
* number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
* production.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
// Cache values to avoid duplicated sloads
bool isTopLevelCall = !$._initializing;
uint64 initialized = $._initialized;
// Allowed calls:
// - initialSetup: the contract is not in the initializing state and no previous version was
// initialized
// - construction: the contract is initialized at version 1 (no reininitialization) and the
// current contract is just being deployed
bool initialSetup = initialized == 0 && isTopLevelCall;
bool construction = initialized == 1 && address(this).code.length == 0;
if (!initialSetup && !construction) {
revert InvalidInitialization();
}
$._initialized = 1;
if (isTopLevelCall) {
$._initializing = true;
}
_;
if (isTopLevelCall) {
$._initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint64 version) {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing || $._initialized >= version) {
revert InvalidInitialization();
}
$._initialized = version;
$._initializing = true;
_;
$._initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
_checkInitializing();
_;
}
/**
* @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
*/
function _checkInitializing() internal view virtual {
if (!_isInitializing()) {
revert NotInitializing();
}
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing) {
revert InvalidInitialization();
}
if ($._initialized != type(uint64).max) {
$._initialized = type(uint64).max;
emit Initialized(type(uint64).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint64) {
return _getInitializableStorage()._initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _getInitializableStorage()._initializing;
}
/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
assembly {
$.slot := INITIALIZABLE_STORAGE
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
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.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/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @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);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/cryptography/MessageHashUtils.sol)
pragma solidity ^0.8.20;
import {Strings} from "../Strings.sol";
/**
* @dev Signature message hash utilities for producing digests to be consumed by {ECDSA} recovery or signing.
*
* The library provides methods for generating a hash of a message that conforms to the
* https://eips.ethereum.org/EIPS/eip-191[ERC-191] and https://eips.ethereum.org/EIPS/eip-712[EIP 712]
* specifications.
*/
library MessageHashUtils {
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing a bytes32 `messageHash` with
* `"\x19Ethereum Signed Message:\n32"` and hashing the result. It corresponds with the
* hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
*
* NOTE: The `messageHash` parameter is intended to be the result of hashing a raw message with
* keccak256, although any bytes32 value can be safely used because the final digest will
* be re-hashed.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes32 messageHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
mstore(0x00, "\x19Ethereum Signed Message:\n32") // 32 is the bytes-length of messageHash
mstore(0x1c, messageHash) // 0x1c (28) is the length of the prefix
digest := keccak256(0x00, 0x3c) // 0x3c is the length of the prefix (0x1c) + messageHash (0x20)
}
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x45` (`personal_sign` messages).
*
* The digest is calculated by prefixing an arbitrary `message` with
* `"\x19Ethereum Signed Message:\n" + len(message)` and hashing the result. It corresponds with the
* hash signed when using the https://eth.wiki/json-rpc/API#eth_sign[`eth_sign`] JSON-RPC method.
*
* See {ECDSA-recover}.
*/
function toEthSignedMessageHash(bytes memory message) internal pure returns (bytes32) {
return
keccak256(bytes.concat("\x19Ethereum Signed Message:\n", bytes(Strings.toString(message.length)), message));
}
/**
* @dev Returns the keccak256 digest of an ERC-191 signed data with version
* `0x00` (data with intended validator).
*
* The digest is calculated by prefixing an arbitrary `data` with `"\x19\x00"` and the intended
* `validator` address. Then hashing the result.
*
* See {ECDSA-recover}.
*/
function toDataWithIntendedValidatorHash(address validator, bytes memory data) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(hex"19_00", validator, data));
}
/**
* @dev Returns the keccak256 digest of an EIP-712 typed data (ERC-191 version `0x01`).
*
* The digest is calculated from a `domainSeparator` and a `structHash`, by prefixing them with
* `\x19\x01` and hashing the result. It corresponds to the hash signed by the
* https://eips.ethereum.org/EIPS/eip-712[`eth_signTypedData`] JSON-RPC method as part of EIP-712.
*
* See {ECDSA-recover}.
*/
function toTypedDataHash(bytes32 domainSeparator, bytes32 structHash) internal pure returns (bytes32 digest) {
assembly ("memory-safe") {
let ptr := mload(0x40)
mstore(ptr, hex"19_01")
mstore(add(ptr, 0x02), domainSeparator)
mstore(add(ptr, 0x22), structHash)
digest := keccak256(ptr, 0x42)
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ShortStrings.sol)
pragma solidity ^0.8.20;
import {StorageSlot} from "./StorageSlot.sol";
// | string | 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA |
// | length | 0x BB |
type ShortString is bytes32;
/**
* @dev This library provides functions to convert short memory strings
* into a `ShortString` type that can be used as an immutable variable.
*
* Strings of arbitrary length can be optimized using this library if
* they are short enough (up to 31 bytes) by packing them with their
* length (1 byte) in a single EVM word (32 bytes). Additionally, a
* fallback mechanism can be used for every other case.
*
* Usage example:
*
* ```solidity
* contract Named {
* using ShortStrings for *;
*
* ShortString private immutable _name;
* string private _nameFallback;
*
* constructor(string memory contractName) {
* _name = contractName.toShortStringWithFallback(_nameFallback);
* }
*
* function name() external view returns (string memory) {
* return _name.toStringWithFallback(_nameFallback);
* }
* }
* ```
*/
library ShortStrings {
// Used as an identifier for strings longer than 31 bytes.
bytes32 private constant FALLBACK_SENTINEL = 0x00000000000000000000000000000000000000000000000000000000000000FF;
error StringTooLong(string str);
error InvalidShortString();
/**
* @dev Encode a string of at most 31 chars into a `ShortString`.
*
* This will trigger a `StringTooLong` error is the input string is too long.
*/
function toShortString(string memory str) internal pure returns (ShortString) {
bytes memory bstr = bytes(str);
if (bstr.length > 31) {
revert StringTooLong(str);
}
return ShortString.wrap(bytes32(uint256(bytes32(bstr)) | bstr.length));
}
/**
* @dev Decode a `ShortString` back to a "normal" string.
*/
function toString(ShortString sstr) internal pure returns (string memory) {
uint256 len = byteLength(sstr);
// using `new string(len)` would work locally but is not memory safe.
string memory str = new string(32);
assembly ("memory-safe") {
mstore(str, len)
mstore(add(str, 0x20), sstr)
}
return str;
}
/**
* @dev Return the length of a `ShortString`.
*/
function byteLength(ShortString sstr) internal pure returns (uint256) {
uint256 result = uint256(ShortString.unwrap(sstr)) & 0xFF;
if (result > 31) {
revert InvalidShortString();
}
return result;
}
/**
* @dev Encode a string into a `ShortString`, or write it to storage if it is too long.
*/
function toShortStringWithFallback(string memory value, string storage store) internal returns (ShortString) {
if (bytes(value).length < 32) {
return toShortString(value);
} else {
StorageSlot.getStringSlot(store).value = value;
return ShortString.wrap(FALLBACK_SENTINEL);
}
}
/**
* @dev Decode a string that was encoded to `ShortString` or written to storage using {setWithFallback}.
*/
function toStringWithFallback(ShortString value, string storage store) internal pure returns (string memory) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return toString(value);
} else {
return store;
}
}
/**
* @dev Return the length of a string that was encoded to `ShortString` or written to storage using
* {setWithFallback}.
*
* WARNING: This will return the "byte length" of the string. This may not reflect the actual length in terms of
* actual characters as the UTF-8 encoding of a single character can span over multiple bytes.
*/
function byteLengthWithFallback(ShortString value, string storage store) internal view returns (uint256) {
if (ShortString.unwrap(value) != FALLBACK_SENTINEL) {
return byteLength(value);
} else {
return bytes(store).length;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC5267.sol)
pragma solidity ^0.8.20;
interface IERC5267 {
/**
* @dev MAY be emitted to signal that the domain could have changed.
*/
event EIP712DomainChanged();
/**
* @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
* signature.
*/
function eip712Domain()
external
view
returns (
bytes1 fields,
string memory name,
string memory version,
uint256 chainId,
address verifyingContract,
bytes32 salt,
uint256[] memory extensions
);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*/
abstract contract ERC165Upgradeable is Initializable, IERC165 {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (utils/Strings.sol)
pragma solidity ^0.8.20;
import {Math} from "./math/Math.sol";
import {SafeCast} from "./math/SafeCast.sol";
import {SignedMath} from "./math/SignedMath.sol";
/**
* @dev String operations.
*/
library Strings {
using SafeCast for *;
bytes16 private constant HEX_DIGITS = "0123456789abcdef";
uint8 private constant ADDRESS_LENGTH = 20;
/**
* @dev The `value` string doesn't fit in the specified `length`.
*/
error StringsInsufficientHexLength(uint256 value, uint256 length);
/**
* @dev The string being parsed contains characters that are not in scope of the given base.
*/
error StringsInvalidChar();
/**
* @dev The string being parsed is not a properly formatted address.
*/
error StringsInvalidAddressFormat();
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
unchecked {
uint256 length = Math.log10(value) + 1;
string memory buffer = new string(length);
uint256 ptr;
assembly ("memory-safe") {
ptr := add(buffer, add(32, length))
}
while (true) {
ptr--;
assembly ("memory-safe") {
mstore8(ptr, byte(mod(value, 10), HEX_DIGITS))
}
value /= 10;
if (value == 0) break;
}
return buffer;
}
}
/**
* @dev Converts a `int256` to its ASCII `string` decimal representation.
*/
function toStringSigned(int256 value) internal pure returns (string memory) {
return string.concat(value < 0 ? "-" : "", toString(SignedMath.abs(value)));
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
unchecked {
return toHexString(value, Math.log256(value) + 1);
}
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length) internal pure returns (string memory) {
uint256 localValue = value;
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = HEX_DIGITS[localValue & 0xf];
localValue >>= 4;
}
if (localValue != 0) {
revert StringsInsufficientHexLength(value, length);
}
return string(buffer);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal
* representation.
*/
function toHexString(address addr) internal pure returns (string memory) {
return toHexString(uint256(uint160(addr)), ADDRESS_LENGTH);
}
/**
* @dev Converts an `address` with fixed length of 20 bytes to its checksummed ASCII `string` hexadecimal
* representation, according to EIP-55.
*/
function toChecksumHexString(address addr) internal pure returns (string memory) {
bytes memory buffer = bytes(toHexString(addr));
// hash the hex part of buffer (skip length + 2 bytes, length 40)
uint256 hashValue;
assembly ("memory-safe") {
hashValue := shr(96, keccak256(add(buffer, 0x22), 40))
}
for (uint256 i = 41; i > 1; --i) {
// possible values for buffer[i] are 48 (0) to 57 (9) and 97 (a) to 102 (f)
if (hashValue & 0xf > 7 && uint8(buffer[i]) > 96) {
// case shift by xoring with 0x20
buffer[i] ^= 0x20;
}
hashValue >>= 4;
}
return string(buffer);
}
/**
* @dev Returns true if the two strings are equal.
*/
function equal(string memory a, string memory b) internal pure returns (bool) {
return bytes(a).length == bytes(b).length && keccak256(bytes(a)) == keccak256(bytes(b));
}
/**
* @dev Parse a decimal string and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input) internal pure returns (uint256) {
return parseUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[0-9]*`
* - The result must fit into an `uint256` type
*/
function parseUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseUint-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseUint} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
uint256 result = 0;
for (uint256 i = begin; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 9) return (false, 0);
result *= 10;
result += chr;
}
return (true, result);
}
/**
* @dev Parse a decimal string and returns the value as a `int256`.
*
* Requirements:
* - The string must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input) internal pure returns (int256) {
return parseInt(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseInt-string} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `[-+]?[0-9]*`
* - The result must fit in an `int256` type.
*/
function parseInt(string memory input, uint256 begin, uint256 end) internal pure returns (int256) {
(bool success, int256 value) = tryParseInt(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseInt-string} that returns false if the parsing fails because of an invalid character or if
* the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(string memory input) internal pure returns (bool success, int256 value) {
return _tryParseIntUncheckedBounds(input, 0, bytes(input).length);
}
uint256 private constant ABS_MIN_INT256 = 2 ** 255;
/**
* @dev Variant of {parseInt-string-uint256-uint256} that returns false if the parsing fails because of an invalid
* character or if the result does not fit in a `int256`.
*
* NOTE: This function will revert if the absolute value of the result does not fit in a `uint256`.
*/
function tryParseInt(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, int256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseIntUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseInt} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseIntUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, int256 value) {
bytes memory buffer = bytes(input);
// Check presence of a negative sign.
bytes1 sign = begin == end ? bytes1(0) : bytes1(_unsafeReadBytesOffset(buffer, begin)); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
bool positiveSign = sign == bytes1("+");
bool negativeSign = sign == bytes1("-");
uint256 offset = (positiveSign || negativeSign).toUint();
(bool absSuccess, uint256 absValue) = tryParseUint(input, begin + offset, end);
if (absSuccess && absValue < ABS_MIN_INT256) {
return (true, negativeSign ? -int256(absValue) : int256(absValue));
} else if (absSuccess && negativeSign && absValue == ABS_MIN_INT256) {
return (true, type(int256).min);
} else return (false, 0);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as a `uint256`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input) internal pure returns (uint256) {
return parseHexUint(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]*`
* - The result must fit in an `uint256` type.
*/
function parseHexUint(string memory input, uint256 begin, uint256 end) internal pure returns (uint256) {
(bool success, uint256 value) = tryParseHexUint(input, begin, end);
if (!success) revert StringsInvalidChar();
return value;
}
/**
* @dev Variant of {parseHexUint-string} that returns false if the parsing fails because of an invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(string memory input) internal pure returns (bool success, uint256 value) {
return _tryParseHexUintUncheckedBounds(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseHexUint-string-uint256-uint256} that returns false if the parsing fails because of an
* invalid character.
*
* NOTE: This function will revert if the result does not fit in a `uint256`.
*/
function tryParseHexUint(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, uint256 value) {
if (end > bytes(input).length || begin > end) return (false, 0);
return _tryParseHexUintUncheckedBounds(input, begin, end);
}
/**
* @dev Implementation of {tryParseHexUint} that does not check bounds. Caller should make sure that
* `begin <= end <= input.length`. Other inputs would result in undefined behavior.
*/
function _tryParseHexUintUncheckedBounds(
string memory input,
uint256 begin,
uint256 end
) private pure returns (bool success, uint256 value) {
bytes memory buffer = bytes(input);
// skip 0x prefix if present
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(buffer, begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 offset = hasPrefix.toUint() * 2;
uint256 result = 0;
for (uint256 i = begin + offset; i < end; ++i) {
uint8 chr = _tryParseChr(bytes1(_unsafeReadBytesOffset(buffer, i)));
if (chr > 15) return (false, 0);
result *= 16;
unchecked {
// Multiplying by 16 is equivalent to a shift of 4 bits (with additional overflow check).
// This guaratees that adding a value < 16 will not cause an overflow, hence the unchecked.
result += chr;
}
}
return (true, result);
}
/**
* @dev Parse a hexadecimal string (with or without "0x" prefix), and returns the value as an `address`.
*
* Requirements:
* - The string must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input) internal pure returns (address) {
return parseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress} that parses a substring of `input` located between position `begin` (included) and
* `end` (excluded).
*
* Requirements:
* - The substring must be formatted as `(0x)?[0-9a-fA-F]{40}`
*/
function parseAddress(string memory input, uint256 begin, uint256 end) internal pure returns (address) {
(bool success, address value) = tryParseAddress(input, begin, end);
if (!success) revert StringsInvalidAddressFormat();
return value;
}
/**
* @dev Variant of {parseAddress-string} that returns false if the parsing fails because the input is not a properly
* formatted address. See {parseAddress} requirements.
*/
function tryParseAddress(string memory input) internal pure returns (bool success, address value) {
return tryParseAddress(input, 0, bytes(input).length);
}
/**
* @dev Variant of {parseAddress-string-uint256-uint256} that returns false if the parsing fails because input is not a properly
* formatted address. See {parseAddress} requirements.
*/
function tryParseAddress(
string memory input,
uint256 begin,
uint256 end
) internal pure returns (bool success, address value) {
if (end > bytes(input).length || begin > end) return (false, address(0));
bool hasPrefix = (end > begin + 1) && bytes2(_unsafeReadBytesOffset(bytes(input), begin)) == bytes2("0x"); // don't do out-of-bound (possibly unsafe) read if sub-string is empty
uint256 expectedLength = 40 + hasPrefix.toUint() * 2;
// check that input is the correct length
if (end - begin == expectedLength) {
// length guarantees that this does not overflow, and value is at most type(uint160).max
(bool s, uint256 v) = _tryParseHexUintUncheckedBounds(input, begin, end);
return (s, address(uint160(v)));
} else {
return (false, address(0));
}
}
function _tryParseChr(bytes1 chr) private pure returns (uint8) {
uint8 value = uint8(chr);
// Try to parse `chr`:
// - Case 1: [0-9]
// - Case 2: [a-f]
// - Case 3: [A-F]
// - otherwise not supported
unchecked {
if (value > 47 && value < 58) value -= 48;
else if (value > 96 && value < 103) value -= 87;
else if (value > 64 && value < 71) value -= 55;
else return type(uint8).max;
}
return value;
}
/**
* @dev Reads a bytes32 from a bytes array without bounds checking.
*
* NOTE: making this function internal would mean it could be used with memory unsafe offset, and marking the
* assembly block as such would prevent some optimizations.
*/
function _unsafeReadBytesOffset(bytes memory buffer, uint256 offset) private pure returns (bytes32 value) {
// This is not memory safe in the general case, but all calls to this private function are within bounds.
assembly ("memory-safe") {
value := mload(add(buffer, add(0x20, offset)))
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/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.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);
}
}
}{
"remappings": [
"@blueberry-v2/=src/",
"@openzeppelin-contracts-upgradeable/=dependencies/@openzeppelin-contracts-upgradeable-5.2.0/",
"@openzeppelin/contracts/=dependencies/@openzeppelin-contracts-5.2.0/",
"@solmate/=dependencies/solmate-6.8.0/src/",
"@solady/=dependencies/solady-0.1.12/src/",
"@openzeppelin-contracts-5.2.0/=dependencies/@openzeppelin-contracts-5.2.0/",
"@openzeppelin-contracts-upgradeable-5.2.0/=dependencies/@openzeppelin-contracts-upgradeable-5.2.0/",
"forge-std/=lib/forge-std/src/",
"solady-0.1.12/=dependencies/solady-0.1.12/src/",
"solmate-6.8.0/=dependencies/solmate-6.8.0/src/"
],
"optimizer": {
"enabled": true,
"runs": 200
},
"metadata": {
"useLiteralContent": false,
"bytecodeHash": "ipfs",
"appendCBOR": true
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"abi"
]
}
},
"evmVersion": "prague",
"viaIR": true
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"address","name":"shareToken_","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"ADDRESS_ZERO","type":"error"},{"inputs":[],"name":"AMOUNT_ZERO","type":"error"},{"inputs":[],"name":"COLLATERAL_NOT_SUPPORTED","type":"error"},{"inputs":[],"name":"FEE_TOO_HIGH","type":"error"},{"inputs":[],"name":"FETCH_ASSETS_FAILED","type":"error"},{"inputs":[],"name":"INVALID_ESCROW_COUNT","type":"error"},{"inputs":[],"name":"INVALID_EVM_ADDRESS","type":"error"},{"inputs":[],"name":"INVALID_FEE_RECIPIENT","type":"error"},{"inputs":[],"name":"INVALID_OPERATION","type":"error"},{"inputs":[],"name":"INVALID_SPOT_MARKET","type":"error"},{"inputs":[],"name":"InvalidInitialization","type":"error"},{"inputs":[],"name":"MIN_DEPOSIT_AMOUNT","type":"error"},{"inputs":[],"name":"NotInitializing","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","type":"error"},{"inputs":[],"name":"PRECOMPILE_CALL_FAILED","type":"error"},{"inputs":[],"name":"ReentrancyGuardReentrantCall","type":"error"},{"inputs":[],"name":"SLIPPAGE_TOO_HIGH","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[],"name":"ZERO_SHARES","type":"error"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint64","name":"assetIndex","type":"uint64"},{"components":[{"internalType":"address","name":"evmContract","type":"address"},{"internalType":"uint8","name":"szDecimals","type":"uint8"},{"internalType":"uint8","name":"weiDecimals","type":"uint8"},{"internalType":"uint8","name":"evmDecimals","type":"uint8"},{"internalType":"uint32","name":"spotMarket","type":"uint32"}],"indexed":false,"internalType":"struct IHyperliquidCommon.AssetDetails","name":"details","type":"tuple"}],"name":"AssetAdded","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint64","name":"assetIndex","type":"uint64"}],"name":"AssetRemoved","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"asset","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"shares","type":"uint256"}],"name":"Deposit","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":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferStarted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":false,"internalType":"uint256","name":"shares","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"Redeem","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint64","name":"assetIndex","type":"uint64"}],"name":"WithdrawAssetUpdated","type":"event"},{"inputs":[],"name":"BPS_DENOMINATOR","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_FEE_NUMERATOR","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"ONE_YEAR","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"SHARE_TOKEN","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"USDC_EVM_SPOT_INDEX","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"V1_HYPERVAULT_ROUTER_STORAGE_LOCATION","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"acceptOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"assetAddr","type":"address"},{"internalType":"uint32","name":"assetIndex_","type":"uint32"},{"internalType":"uint32","name":"spotMarket","type":"uint32"}],"name":"addAsset","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint64","name":"assetIndex_","type":"uint64"}],"name":"assetDetails","outputs":[{"components":[{"internalType":"address","name":"evmContract","type":"address"},{"internalType":"uint8","name":"szDecimals","type":"uint8"},{"internalType":"uint8","name":"weiDecimals","type":"uint8"},{"internalType":"uint8","name":"evmDecimals","type":"uint8"},{"internalType":"uint32","name":"spotMarket","type":"uint32"}],"internalType":"struct IHyperliquidCommon.AssetDetails","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"}],"name":"assetIndex","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"uint256","name":"minOut","type":"uint256"}],"name":"deposit","outputs":[{"internalType":"uint256","name":"shares","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"depositEscrowIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"index","type":"uint256"}],"name":"escrows","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"feeRecipient","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address[]","name":"escrows_","type":"address[]"},{"internalType":"uint64","name":"minDeposit_","type":"uint64"},{"internalType":"address","name":"owner_","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint64","name":"assetIndex_","type":"uint64"}],"name":"isAssetSupported","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"lastFeeCollectionTimestamp","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"managementFee","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"maxRedeemable","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"maxWithdrawable","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"minDeposit","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pendingOwner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pokeFees","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"previewDeposit","outputs":[{"internalType":"uint256","name":"shares","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"shares","type":"uint256"}],"name":"previewRedeem","outputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"shares","type":"uint256"},{"internalType":"uint256","name":"minOut","type":"uint256"}],"name":"redeem","outputs":[{"internalType":"uint256","name":"amount","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"}],"name":"removeAsset","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newFeeRecipient_","type":"address"}],"name":"setFeeRecipient","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint64","name":"newManagementFeeBps_","type":"uint64"}],"name":"setManagementFeeBps","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"newMinDepositValue_","type":"uint256"}],"name":"setMinDepositValue","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"}],"name":"setWithdrawAsset","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"tvl","outputs":[{"internalType":"uint256","name":"tvl_","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"withdrawAsset","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]Contract Creation Code
60a03461013357601f612b1b38819003918201601f19168301916001600160401b038311848410176101375780849260209460405283398101031261013357516001600160a01b0381168082036101335715610124576080525f516020612afb5f395f51905f525460ff8160401c16610115576002600160401b03196001600160401b038216016100bf575b6040516129af908161014c8239608051818181610e210152818161194b01528181611be2015281816123cf01526125550152f35b6001600160401b0319166001600160401b039081175f516020612afb5f395f51905f52556040519081527fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d290602090a15f61008b565b63f92ee8a960e01b5f5260045ffd5b6366e7950960e01b5f5260045ffd5b5f80fd5b634e487b7160e01b5f52604160045260245ffdfe60806040526004361015610011575f80fd5b5f5f3560e01c8063012f52ee14611de5578063066d1e8514611db057806308be381b14611d0a5780630efe6a8b146119e457806314526ea21461199957806316d3bfbb1461197a5780631d7e3556146119355780632ab689c1146116145780632eec6bcb146115e857806341b3d185146115c15780634351dd3614611492578063469048401461146d5780634a5e42b1146112bd5780634cdad5061461119b57806352c8c3c01461116e57806364b54b961461115357806364e1274e14611138578063715018a6146110b957806379ba5097146110695780637cbc237314610c99578063822ed91314610c645780638da5cb5b14610c2f578063a6f7f5d614610bff578063ab51166b14610be3578063b8f82b2614610a58578063c4945afb146109a0578063d09a018f14610391578063d259a76d14610361578063d3c3962f14610346578063e1a4521814610329578063e30c3978146102f4578063e5328e06146102d9578063e74b981b1461026e578063f2fde38b146101e8578063f514970f146101c55763fd9b5687146101a6575f80fd5b346101c257806003193601126101c25760206040516105dc8152f35b80fd5b50346101c257806003193601126101c25760206101e06122f5565b604051908152f35b50346101c25760203660031901126101c257610202611e3d565b61020a612366565b5f51602061295a5f395f51905f5280546001600160a01b0319166001600160a01b039283169081179091555f5160206128fa5f395f51905f52549091167f38d16b8cac22d99fc7c124b9cd0de2d3fa1faef420bfe791d8c362d765e227008380a380f35b50346101c25760203660031901126101c257610288611e3d565b610290612366565b6001600160a01b038116156102ca5760086102a9611f2d565b0180546001600160a01b0319166001600160a01b0390921691909117905580f35b6359a2c9eb60e01b8252600482fd5b50346101c257806003193601126101c25760206101e061224b565b50346101c257806003193601126101c2575f51602061295a5f395f51905f52546040516001600160a01b039091168152602090f35b50346101c257806003193601126101c25760206040516127108152f35b50346101c257806003193601126101c25760206101e0612186565b50346101c257806003193601126101c25760206001600160a01b036002610386611f2d565b015416604051908152f35b50346101c25760603660031901126101c2576103ab611e3d565b9060243563ffffffff811680910361099c576044359063ffffffff82168092036107a4576103d7612366565b6103df611f2d565b6103f06103ea61224b565b82612399565b8360e06040516103ff81611e82565b60608152606060208201528260408201528260608201528260808201528260a08201528260c082015201528380604051602081019085825260208152610446604082611eb9565b519061080c5afa946104566126a5565b951561098d5785518601906020820196602081840312610989576020810151906001600160401b0382116109815701916101009083900312610985576040519661049f88611e82565b60208301516001600160401b038111610981578160206104c1928601016126d4565b885260408301516001600160401b038111610981576020908401019080601f830112156109815781516104f381611eda565b926105016040519485611eb9565b81845260208085019260051b82010192831161094757602001905b8282106109695750505060208801526105376060830161271a565b60408801526105486080830161272e565b606088015261055960a0830161272e565b94608088019786895261056e60c08501612742565b9660a0820197885261010061058560e08701612742565b9560c08401968752015191828a0b83036109475760e0019182526001600160a01b0384811691160361095a57856107cb5760088501805460ff60a01b1916600160a01b1790555b60ff845116880b9051880b01607f198112607f8213176107b75760ff8060039798999a60018060a01b03905116995116945116926040519861060d8a611e53565b89526020808a019586526040808b0195865260ff9390931660608b0190815260808b019485526001600160a01b039283165f908152600489018352849020805467ffffffffffffffff19166001600160401b038c16179055898c5260058801909152918a208951815496519551935194516001600160d81b031990971692169190911760a09490941b60ff60a01b169390931760a89190911b60ff60a81b161760b09190911b60ff60b01b161760b89290921b63ffffffff60b81b169190911790556106dc83600683016128ac565b500183815491815b83811061072857827f5604f838235e03419cb66bc82a99aa4bc857a665d1e92dbf3ec21d4ae4900a0d60c0876107248a6040519283526020830190611f97565ba180f35b6107328183611fdb565b905460039190911b1c6001600160a01b0316803b156107b35783809160c4604051809481936337b1f8c560e11b83528b60048401526107758d6024850190611f97565b5af19081156107a857849161078f575b50506001016106e4565b8161079991611eb9565b6107a457825f610785565b8280fd5b6040513d86823e3d90fd5b8380fd5b634e487b7160e01b88526011600452602488fd5b87806040516020810190858252602081526107e7604082611eb9565b519061080b5afa6107f66126a5565b901561094b578051810190602082019060208184031261093f576020810151906001600160401b03821161094357019160609083900312610947576040519061083e82611e9e565b60208301516001600160401b03811161094357816020610860928601016126d4565b825280605f8401121561093f576040519261087a84611e9e565b83906080810192831161093b579060408b94939201905b82821061091a5750505060200182815291516001600160401b0316149081610903575b81156108cf575b506105cc5763016549a960e31b8852600488fd5b8051602001516001600160401b031688149150816108ef575b505f6108bb565b6001600160401b039150515116155f6108e8565b8051602001516001600160401b03161591506108b4565b81929394506020919061092d839261271a565b81520191018a939291610891565b8c80fd5b8a80fd5b8b80fd5b8980fd5b630fa4c76960e11b8952600489fd5b6318f4084560e31b8852600488fd5b602080916109768461271a565b81520191019061051c565b8780fd5b8580fd5b8680fd5b630fa4c76960e11b8552600485fd5b5080fd5b50346101c25760203660031901126101c2576109ba611e27565b9060806040516109c981611e53565b82815282602082015282604082015282606082015201526001600160401b0360056109f2611f2d565b0191165f5260205260a060405f2063ffffffff60405191610a1283611e53565b54600180851b038116835260ff81851c16602084015260ff8160a81c16604084015260ff8160b01c16606084015260b81c166080820152610a566040518092611f97565bf35b50346101c25760403660031901126101c257610a72611e3d565b90610a7b611f2d565b90610a90610a876122f5565b60038401611fdb565b60018060a01b0391549060031b1c169260018060a01b0381165f52600483016020526001600160401b0360405f20541690610acb8285612332565b15610bd4576001600160401b0382165f526005840160205260405f209260405193610af585611e53565b546001600160a01b0380821680875260a083901c60ff908116602089015260a884901c8116604089015260b084901c166060880190815260b89390931c63ffffffff16608088015291931603610bc55750610b6f610b7e9360209693610b69610b6460ff610b78965116612004565b612015565b94612484565b91602435612026565b90612518565b90610b87612540565b610b945750604051908152f35b610bc091610bba610bad610ba661224b565b8094612610565b610bb5612540565b612039565b90612590565b6101e0565b6318f4084560e31b8152600490fd5b63febd867360e01b8352600483fd5b50346101c257806003193601126101c257602090604051908152f35b50346101c257806003193601126101c25760206001600160401b03610c22611f2d565b5460401c16604051908152f35b50346101c257806003193601126101c2575f5160206128fa5f395f51905f52546040516001600160a01b039091168152602090f35b50346101c257806003193601126101c257610c7d61244c565b610c85612148565b60015f51602061291a5f395f51905f525580f35b50346101c25760403660031901126101c25760043590610cb761244c565b610cbf611f2d565b8215611057576002810180549091906001600160a01b03161561104857610ddd610d03610cea61224b565b610cf48185612399565b610cfc612540565b9087612590565b60018060a01b0384541660018060a01b03165f5260048301602052610dd76001600160401b0360405f205416936001600160401b0385165f5260058101602052610dd260405f20600360405191610d5983611e53565b549360018060a01b038516835260ff8560a01c16602084015260ff8560a81c16604084015263ffffffff606084019560ff8160b01c16875260b81c1660808401520196610dcc610b6460ff610db5610daf6122f5565b8c611fdb565b60018060a01b0391549060031b1c16965116612004565b93612484565b612026565b9061264c565b93841561103957602435851061102a576040518181528560208201527fe5b754fb1abb7f01b499791d0b820ae3b6af3424ac1c59768edb53f4ec31a92960403392a27f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690813b156110265760405163079cc67960e41b815233600482015260248101919091529084908290604490829084905af180156107a857908491611011575b50508391815491845b838110610ecc575b50505050610ebd5760208260015f51602061291a5f395f51905f5255604051908152f35b63661e5add60e01b8152600490fd5b610ed68183611fdb565b905484546040516370a0823160e01b815260039390931b9190911c6001600160a01b03908116600484018190529116602083602481845afa928315611006578993610fcf575b50828810838918028084189303610f44575b5050508415610f3f57600101610e91565b610e99565b81979293973b15610fcb57604051631501bf0360e01b81526001600160a01b03919091166004820152336024820152604481018490529088908290606490829084905af18015610fc057908891610fab575b505090610fa291611f0c565b935f8080610f2e565b81610fb591611eb9565b61098957865f610f96565b6040513d8a823e3d90fd5b8880fd5b9092506020813d8211610ffe575b81610fea60209383611eb9565b81010312610ffa5751915f610f1c565b5f80fd5b3d9150610fdd565b6040513d8b823e3d90fd5b8161101b91611eb9565b6107a457825f610e88565b8480fd5b6304a6523360e01b8452600484fd5b6301f4d90760e41b8452600484fd5b6366e7950960e01b8352600483fd5b6001622c3a8160e21b03198252600482fd5b50346101c257806003193601126101c2575f51602061295a5f395f51905f5254336001600160a01b03909116036110a6576110a3336125a5565b80f35b63118cdaa760e01b815233600452602490fd5b50346101c257806003193601126101c2576110d2612366565b5f51602061295a5f395f51905f5280546001600160a01b03199081169091555f5160206128fa5f395f51905f528054918216905581906001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a380f35b50346101c257806003193601126101c25760206101e0612046565b50346101c257806003193601126101c25760206101e0611f2d565b50346101c257806003193601126101c25760206001600160401b03611191611f2d565b5416604051908152f35b50346101c25760203660031901126101c2576004356111b8611f2d565b9080156112ab5760028201546001600160a01b031692831561129c5760206101e085610dd7866111fd876111ea61224b565b6111f7610bad8286612610565b91612590565b9260018060a01b03165f52600481018552610dd26001600160401b0360405f2054166001600160401b0381165f5260058301875260405f2090610dcc610b6460ff610db56040519561124e87611e53565b549760018060a01b0389168752828960a01c168d880152828960a81c16604088015263ffffffff6060880199848160b01c168b5260b81c16608088015260036112956122f5565b9101611fdb565b6366e7950960e01b8152600490fd5b6001622c3a8160e21b03198352600483fd5b50346101c25760203660031901126101c2576112d7611e3d565b906112e0612366565b6112e8611f2d565b6001600160a01b039283165f818152600483016020819052604090912054600284015492956001600160401b03909116939216851461145e5760058201906001600160401b0384165f52816020528560405f2060018060a01b039054160361144f578394956003941561143b575b5f5260205260405f206001600160401b031981541690556001600160401b0384165f526020528360405f205561138f836006830161277b565b500182815491815b8381106113cd57827fafed6c079ee205fd4c1a084bd8370f11064830354454865a7c6d59b31e3bfc04602087604051908152a180f35b6113d78183611fdb565b905460039190911b1c6001600160a01b0316803b156107b357838091602460405180948193637b66445b60e11b83528b60048401525af19081156107a8578491611426575b5050600101611397565b8161143091611eb9565b6107a457825f61141c565b60088401805460ff60a01b19169055611356565b63febd867360e01b8552600485fd5b63ebf613c160e01b8452600484fd5b50346101c257806003193601126101c25760206001600160a01b036008610386611f2d565b50346101c25760203660031901126101c2576114ac611e3d565b6114b4612366565b6114bc611f2d565b9060018060a01b0381165f52600482016020526001600160401b0360405f205416916001600160401b0383165f526005810160205260405f2063ffffffff6040519161150783611e53565b5460018060a01b038116835260ff8160a01c16602084015260ff8160a81c16604084015260ff8160b01c16606084015260b81c16608082015261154a8483612332565b1561144f57516001600160a01b03908116908316036115b25760020180546001600160a01b0319166001600160a01b039092169190911790556040519081527f385c61a19f2dbdd23a28adf7c6a8ce47b8819680ae11cbb3f69ae3a29f02be8d90602090a180f35b6318f4084560e31b8452600484fd5b50346101c257806003193601126101c257602060016115de611f2d565b0154604051908152f35b50346101c25760203660031901126101c257611602612366565b600435600161160f611f2d565b015580f35b50346101c25760603660031901126101c257600435906001600160401b0382116101c257366023830112156101c257816004013561165181611eda565b9261165f6040519485611eb9565b81845260208401906024829360051b8201019036821161102657602401915b818310611915575050506024356001600160401b0381168091036107a4576044356001600160a01b03811692909190838303611026575f51602061293a5f395f51905f52549360ff8560401c1615946001600160401b0381168015908161190d575b6001149081611903575b1590816118fa575b506118eb5767ffffffffffffffff1981166001175f51602061293a5f395f51905f5255856118bf575b5080156118b05760058751116118a157611733611f2d565b92600184015560088301906bffffffffffffffffffffffff60a01b825416179055600382019551906001600160401b03821161188d57600160401b821161188d578654828855808310611867575b509585526020852095855b82811061184a57505081546fffffffffffffffff000000000000000019166896000000000000000017909155506117eb906117c5612750565b6117cd612750565b6117d5612750565b60015f51602061291a5f395f51905f52556125a5565b6117f25780f35b68ff0000000000000000195f51602061293a5f395f51905f5254165f51602061293a5f395f51905f52557fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2602060405160018152a180f35b81516001600160a01b03168189015560209091019060010161178c565b878752826020882091820191015b8181106118825750611781565b878155600101611875565b634e487b7160e01b86526041600452602486fd5b6310cefe7b60e21b8652600486fd5b6366e7950960e01b8652600486fd5b68ffffffffffffffffff191668010000000000000001175f51602061293a5f395f51905f52555f61171b565b63f92ee8a960e01b8752600487fd5b9050155f6116f2565b303b1591506116ea565b8791506116e0565b82356001600160a01b03811681036109855781526020928301920161167e565b50346101c257806003193601126101c2576040517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b50346101c257806003193601126101c25760206040516301da9c008152f35b50346101c25760203660031901126101c2576119b3611e3d565b60046119bd611f2d565b019060018060a01b03165f5260205260206001600160401b0360405f205416604051908152f35b34610ffa576060366003190112610ffa576119fd611e3d565b60243590611a0961244c565b611a11611f2d565b91611a26611a1d6122f5565b60038501611fdb565b60018060a01b0391549060031b1c169060018060a01b0383165f52600484016020526001600160401b0360405f205416611a608186612332565b15611cfb576001600160401b0381165f526005850160205260405f209060405191611a8a83611e53565b549160018060a01b0383169586825260ff8460a01c16602083015260ff8460a81c16604083015263ffffffff606083019460ff8160b01c16865260b81c16608083015260018060a01b0316809603611cec57611afd610b7891611af6610b6460ff611b04975116612004565b9387612484565b9184612026565b60018501548110611cdd57611b17612540565b611ca857845467ffffffffffffffff1916426001600160401b0316179094555b6044358410611c9957602091611bb6611bc45f938660405182815289888201527fdcbc1c05240f31ff3ad067ef1ee35ce4997762752e3a095284754544f4c709d760403392a36040516323b872dd60e01b8782019081523360248301526001600160a01b03909516604482015260648101919091529182906084820190565b03601f198101835282611eb9565b519082855af115611c73575f513d611c905750803b155b611c7e57507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690813b15610ffa576040516340c10f1960e01b815233600482015260248101829052915f908390604490829084905af1918215611c7357602092611c63575b5060015f51602061291a5f395f51905f5255604051908152f35b5f611c6d91611eb9565b5f611c49565b6040513d5f823e3d90fd5b635274afe760e01b5f5260045260245ffd5b60011415611bdb565b6304a6523360e01b5f5260045ffd5b93611cc89194611cc0611cb961224b565b8093612399565b610bba612540565b9283611b3757633fd3c57f60e21b5f5260045ffd5b631ea30fef60e01b5f5260045ffd5b6318f4084560e31b5f5260045ffd5b63febd867360e01b5f5260045ffd5b34610ffa576020366003190112610ffa57611d23611e27565b611d2b612366565b6105dc6001600160401b0382161015611da157611d46611f2d565b6001600160401b03815416611d89575b50611d5f611f2d565b9067ffffffffffffffff60401b82549160401b169067ffffffffffffffff60401b19161790555f80f35b611d9b90611d9561224b565b90612399565b81611d56565b6345fbd9c160e01b5f5260045ffd5b34610ffa576020366003190112610ffa576020611ddb611dce611e27565b611dd6611f2d565b612332565b6040519015158152f35b34610ffa576020366003190112610ffa576020611e0e6004356003611e08611f2d565b01611fdb565b905460405160039290921b1c6001600160a01b03168152f35b600435906001600160401b0382168203610ffa57565b600435906001600160a01b0382168203610ffa57565b60a081019081106001600160401b03821117611e6e57604052565b634e487b7160e01b5f52604160045260245ffd5b61010081019081106001600160401b03821117611e6e57604052565b604081019081106001600160401b03821117611e6e57604052565b90601f801991011681019081106001600160401b03821117611e6e57604052565b6001600160401b038111611e6e5760051b60200190565b6001600160401b038111611e6e57601f01601f191660200190565b91908203918211611f1957565b634e487b7160e01b5f52601160045260245ffd5b601c6020604051611f3f604082611eb9565b828152017f68797065727661756c742e726f757465722e76312e73746f72616765000000008152205f198101908111611f1957604051906020820190815260208252611f8c604083611eb9565b9051902060ff191690565b63ffffffff6080809260018060a01b03815116855260ff602082015116602086015260ff604082015116604086015260ff6060820151166060860152015116910152565b8054821015611ff0575f5260205f2001905f90565b634e487b7160e01b5f52603260045260245ffd5b60ff166012039060ff8211611f1957565b60ff16604d8111611f1957600a0a90565b81810292918115918404141715611f1957565b91908201809211611f1957565b61204e611f2d565b60028101546001600160a01b03165f9081526004820160209081526040808320546001600160401b03168084526005850190925291829020915190916120f5919061209882611e53565b549260018060a01b038416825260ff8460a01c16602083015260ff8460a81c16604083015263ffffffff606083019460ff8160b01c16865260b81c166080830152610dcc610b6460ff610db56120ec6122f5565b60038a01611fdb565b6120fd612186565b9081156121405761211192610b7891612026565b61211961224b565b90811561213957612130610bad8361213695612610565b90612688565b90565b5050505f90565b505050505f90565b612150611f2d565b61215861224b565b80156121695761216791612399565b565b50805467ffffffffffffffff1916426001600160401b0316179055565b61218e611f2d565b6003810180546002909201545f92839290916001600160a01b0316905b8284106121b9575050505090565b909192936121c78583611fdb565b90546040516370a0823160e01b815260039290921b1c6001600160a01b03166004820152602081602481875afa908115611c73575f91612219575b5061220f90600192612039565b94019291906121ab565b90506020813d8211612243575b8161223360209383611eb9565b81010312610ffa57516001612202565b3d9150612226565b5f906003612257611f2d565b0180545f915b81831061226957505050565b9091936004602061227a8785611fdb565b9054604051637299470360e11b81529384929091839160031b1c6001600160a01b03165afa908115611c73575f916122c3575b506122ba90600192612039565b9401919061225d565b90506020813d82116122ed575b816122dd60209383611eb9565b81010312610ffa575160016122ad565b3d91506122d0565b60036122ff611f2d565b01546001811461232d578015612319576202a30042040690565b634e487b7160e01b5f52601260045260245ffd5b505f90565b906001600160401b03168015612358575f90815260079091016020526040902054151590565b506008015460a01c60ff1690565b5f5160206128fa5f395f51905f52546001600160a01b0316330361238657565b63118cdaa760e01b5f523360045260245ffd5b906123a49082612610565b815467ffffffffffffffff1916426001600160401b0316178255806123c7575050565b6008909101547f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0390811692911690823b15610ffa576040516340c10f1960e01b81526001600160a01b039290921660048301526024820152905f908290604490829084905af18015611c73576124425750565b5f61216791611eb9565b60025f51602061291a5f395f51905f5254146124755760025f51602061291a5f395f51905f5255565b633ee5aeb560e01b5f5260045ffd5b9190612498575050670de0b6b3a764000090565b608081015160209182015160405163bbc6626160e01b815263ffffffff909216600483015260ff16602482015291829060449082906001600160a01b03165afa908115611c73575f916124e9575090565b90506020813d602011612510575b8161250460209383611eb9565b81010312610ffa575190565b3d91506124f7565b90805f19048211810215670de0b6b3a76400000215610ffa57670de0b6b3a764000091020490565b6040516318160ddd60e01b81526020816004817f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03165afa908115611c73575f916124e9575090565b815f19048111820215830215610ffa57020490565b5f51602061295a5f395f51905f5280546001600160a01b03199081169091555f5160206128fa5f395f51905f5280549182166001600160a01b0393841690811790915591167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e05f80a3565b9061261e816121369361284e565b9080821015612640575b61263a82612634612540565b92611f0c565b91612688565b80915060011c90612628565b7812725dd1d243aba0e75fe645cc4873f9e65afe688c928e1f218111670de0b6b3a76400000215820215610ffa57670de0b6b3a7640000020490565b815f19048111820215830215610ffa570290808204910615150190565b3d156126cf573d906126b682611ef1565b916126c46040519384611eb9565b82523d5f602084013e565b606090565b81601f82011215610ffa578051906126eb82611ef1565b926126f96040519485611eb9565b82845260208383010111610ffa57815f9260208093018386015e8301015290565b51906001600160401b0382168203610ffa57565b51906001600160a01b0382168203610ffa57565b519060ff82168203610ffa57565b60ff5f51602061293a5f395f51905f525460401c161561276c57565b631afcd79f60e31b5f5260045ffd5b906001820191815f528260205260405f20548015155f14612140575f198101818111611f195782545f19810191908211611f1957818103612803575b505050805480156127ef575f1901906127d08282611fdb565b8154905f199060031b1b19169055555f526020525f6040812055600190565b634e487b7160e01b5f52603160045260245ffd5b6128396128136128239386611fdb565b90549060031b1c92839286611fdb565b819391549060031b91821b915f19901b19161790565b90555f528360205260405f20555f80806127b7565b9080158015612898575b6128925761288d61271091610dd26301da9c009454916001600160401b0361288281851642611f0c565b9360401c1690612026565b040490565b50505f90565b506001600160401b03825416421115612858565b5f82815260018201602052604090205461289257805490600160401b821015611e6e57826128e4612823846001809601855584611fdb565b90558054925f520160205260405f205560019056fe9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c1993009b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00f0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00a264697066735822122026331d4c3c929c3129563bea9636bea775a9c925ea700ded401c70a3cc4d700064736f6c634300081c0033f0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a000000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc
Deployed Bytecode
0x60806040526004361015610011575f80fd5b5f5f3560e01c8063012f52ee14611de5578063066d1e8514611db057806308be381b14611d0a5780630efe6a8b146119e457806314526ea21461199957806316d3bfbb1461197a5780631d7e3556146119355780632ab689c1146116145780632eec6bcb146115e857806341b3d185146115c15780634351dd3614611492578063469048401461146d5780634a5e42b1146112bd5780634cdad5061461119b57806352c8c3c01461116e57806364b54b961461115357806364e1274e14611138578063715018a6146110b957806379ba5097146110695780637cbc237314610c99578063822ed91314610c645780638da5cb5b14610c2f578063a6f7f5d614610bff578063ab51166b14610be3578063b8f82b2614610a58578063c4945afb146109a0578063d09a018f14610391578063d259a76d14610361578063d3c3962f14610346578063e1a4521814610329578063e30c3978146102f4578063e5328e06146102d9578063e74b981b1461026e578063f2fde38b146101e8578063f514970f146101c55763fd9b5687146101a6575f80fd5b346101c257806003193601126101c25760206040516105dc8152f35b80fd5b50346101c257806003193601126101c25760206101e06122f5565b604051908152f35b50346101c25760203660031901126101c257610202611e3d565b61020a612366565b5f51602061295a5f395f51905f5280546001600160a01b0319166001600160a01b039283169081179091555f5160206128fa5f395f51905f52549091167f38d16b8cac22d99fc7c124b9cd0de2d3fa1faef420bfe791d8c362d765e227008380a380f35b50346101c25760203660031901126101c257610288611e3d565b610290612366565b6001600160a01b038116156102ca5760086102a9611f2d565b0180546001600160a01b0319166001600160a01b0390921691909117905580f35b6359a2c9eb60e01b8252600482fd5b50346101c257806003193601126101c25760206101e061224b565b50346101c257806003193601126101c2575f51602061295a5f395f51905f52546040516001600160a01b039091168152602090f35b50346101c257806003193601126101c25760206040516127108152f35b50346101c257806003193601126101c25760206101e0612186565b50346101c257806003193601126101c25760206001600160a01b036002610386611f2d565b015416604051908152f35b50346101c25760603660031901126101c2576103ab611e3d565b9060243563ffffffff811680910361099c576044359063ffffffff82168092036107a4576103d7612366565b6103df611f2d565b6103f06103ea61224b565b82612399565b8360e06040516103ff81611e82565b60608152606060208201528260408201528260608201528260808201528260a08201528260c082015201528380604051602081019085825260208152610446604082611eb9565b519061080c5afa946104566126a5565b951561098d5785518601906020820196602081840312610989576020810151906001600160401b0382116109815701916101009083900312610985576040519661049f88611e82565b60208301516001600160401b038111610981578160206104c1928601016126d4565b885260408301516001600160401b038111610981576020908401019080601f830112156109815781516104f381611eda565b926105016040519485611eb9565b81845260208085019260051b82010192831161094757602001905b8282106109695750505060208801526105376060830161271a565b60408801526105486080830161272e565b606088015261055960a0830161272e565b94608088019786895261056e60c08501612742565b9660a0820197885261010061058560e08701612742565b9560c08401968752015191828a0b83036109475760e0019182526001600160a01b0384811691160361095a57856107cb5760088501805460ff60a01b1916600160a01b1790555b60ff845116880b9051880b01607f198112607f8213176107b75760ff8060039798999a60018060a01b03905116995116945116926040519861060d8a611e53565b89526020808a019586526040808b0195865260ff9390931660608b0190815260808b019485526001600160a01b039283165f908152600489018352849020805467ffffffffffffffff19166001600160401b038c16179055898c5260058801909152918a208951815496519551935194516001600160d81b031990971692169190911760a09490941b60ff60a01b169390931760a89190911b60ff60a81b161760b09190911b60ff60b01b161760b89290921b63ffffffff60b81b169190911790556106dc83600683016128ac565b500183815491815b83811061072857827f5604f838235e03419cb66bc82a99aa4bc857a665d1e92dbf3ec21d4ae4900a0d60c0876107248a6040519283526020830190611f97565ba180f35b6107328183611fdb565b905460039190911b1c6001600160a01b0316803b156107b35783809160c4604051809481936337b1f8c560e11b83528b60048401526107758d6024850190611f97565b5af19081156107a857849161078f575b50506001016106e4565b8161079991611eb9565b6107a457825f610785565b8280fd5b6040513d86823e3d90fd5b8380fd5b634e487b7160e01b88526011600452602488fd5b87806040516020810190858252602081526107e7604082611eb9565b519061080b5afa6107f66126a5565b901561094b578051810190602082019060208184031261093f576020810151906001600160401b03821161094357019160609083900312610947576040519061083e82611e9e565b60208301516001600160401b03811161094357816020610860928601016126d4565b825280605f8401121561093f576040519261087a84611e9e565b83906080810192831161093b579060408b94939201905b82821061091a5750505060200182815291516001600160401b0316149081610903575b81156108cf575b506105cc5763016549a960e31b8852600488fd5b8051602001516001600160401b031688149150816108ef575b505f6108bb565b6001600160401b039150515116155f6108e8565b8051602001516001600160401b03161591506108b4565b81929394506020919061092d839261271a565b81520191018a939291610891565b8c80fd5b8a80fd5b8b80fd5b8980fd5b630fa4c76960e11b8952600489fd5b6318f4084560e31b8852600488fd5b602080916109768461271a565b81520191019061051c565b8780fd5b8580fd5b8680fd5b630fa4c76960e11b8552600485fd5b5080fd5b50346101c25760203660031901126101c2576109ba611e27565b9060806040516109c981611e53565b82815282602082015282604082015282606082015201526001600160401b0360056109f2611f2d565b0191165f5260205260a060405f2063ffffffff60405191610a1283611e53565b54600180851b038116835260ff81851c16602084015260ff8160a81c16604084015260ff8160b01c16606084015260b81c166080820152610a566040518092611f97565bf35b50346101c25760403660031901126101c257610a72611e3d565b90610a7b611f2d565b90610a90610a876122f5565b60038401611fdb565b60018060a01b0391549060031b1c169260018060a01b0381165f52600483016020526001600160401b0360405f20541690610acb8285612332565b15610bd4576001600160401b0382165f526005840160205260405f209260405193610af585611e53565b546001600160a01b0380821680875260a083901c60ff908116602089015260a884901c8116604089015260b084901c166060880190815260b89390931c63ffffffff16608088015291931603610bc55750610b6f610b7e9360209693610b69610b6460ff610b78965116612004565b612015565b94612484565b91602435612026565b90612518565b90610b87612540565b610b945750604051908152f35b610bc091610bba610bad610ba661224b565b8094612610565b610bb5612540565b612039565b90612590565b6101e0565b6318f4084560e31b8152600490fd5b63febd867360e01b8352600483fd5b50346101c257806003193601126101c257602090604051908152f35b50346101c257806003193601126101c25760206001600160401b03610c22611f2d565b5460401c16604051908152f35b50346101c257806003193601126101c2575f5160206128fa5f395f51905f52546040516001600160a01b039091168152602090f35b50346101c257806003193601126101c257610c7d61244c565b610c85612148565b60015f51602061291a5f395f51905f525580f35b50346101c25760403660031901126101c25760043590610cb761244c565b610cbf611f2d565b8215611057576002810180549091906001600160a01b03161561104857610ddd610d03610cea61224b565b610cf48185612399565b610cfc612540565b9087612590565b60018060a01b0384541660018060a01b03165f5260048301602052610dd76001600160401b0360405f205416936001600160401b0385165f5260058101602052610dd260405f20600360405191610d5983611e53565b549360018060a01b038516835260ff8560a01c16602084015260ff8560a81c16604084015263ffffffff606084019560ff8160b01c16875260b81c1660808401520196610dcc610b6460ff610db5610daf6122f5565b8c611fdb565b60018060a01b0391549060031b1c16965116612004565b93612484565b612026565b9061264c565b93841561103957602435851061102a576040518181528560208201527fe5b754fb1abb7f01b499791d0b820ae3b6af3424ac1c59768edb53f4ec31a92960403392a27f0000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc6001600160a01b031690813b156110265760405163079cc67960e41b815233600482015260248101919091529084908290604490829084905af180156107a857908491611011575b50508391815491845b838110610ecc575b50505050610ebd5760208260015f51602061291a5f395f51905f5255604051908152f35b63661e5add60e01b8152600490fd5b610ed68183611fdb565b905484546040516370a0823160e01b815260039390931b9190911c6001600160a01b03908116600484018190529116602083602481845afa928315611006578993610fcf575b50828810838918028084189303610f44575b5050508415610f3f57600101610e91565b610e99565b81979293973b15610fcb57604051631501bf0360e01b81526001600160a01b03919091166004820152336024820152604481018490529088908290606490829084905af18015610fc057908891610fab575b505090610fa291611f0c565b935f8080610f2e565b81610fb591611eb9565b61098957865f610f96565b6040513d8a823e3d90fd5b8880fd5b9092506020813d8211610ffe575b81610fea60209383611eb9565b81010312610ffa5751915f610f1c565b5f80fd5b3d9150610fdd565b6040513d8b823e3d90fd5b8161101b91611eb9565b6107a457825f610e88565b8480fd5b6304a6523360e01b8452600484fd5b6301f4d90760e41b8452600484fd5b6366e7950960e01b8352600483fd5b6001622c3a8160e21b03198252600482fd5b50346101c257806003193601126101c2575f51602061295a5f395f51905f5254336001600160a01b03909116036110a6576110a3336125a5565b80f35b63118cdaa760e01b815233600452602490fd5b50346101c257806003193601126101c2576110d2612366565b5f51602061295a5f395f51905f5280546001600160a01b03199081169091555f5160206128fa5f395f51905f528054918216905581906001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a380f35b50346101c257806003193601126101c25760206101e0612046565b50346101c257806003193601126101c25760206101e0611f2d565b50346101c257806003193601126101c25760206001600160401b03611191611f2d565b5416604051908152f35b50346101c25760203660031901126101c2576004356111b8611f2d565b9080156112ab5760028201546001600160a01b031692831561129c5760206101e085610dd7866111fd876111ea61224b565b6111f7610bad8286612610565b91612590565b9260018060a01b03165f52600481018552610dd26001600160401b0360405f2054166001600160401b0381165f5260058301875260405f2090610dcc610b6460ff610db56040519561124e87611e53565b549760018060a01b0389168752828960a01c168d880152828960a81c16604088015263ffffffff6060880199848160b01c168b5260b81c16608088015260036112956122f5565b9101611fdb565b6366e7950960e01b8152600490fd5b6001622c3a8160e21b03198352600483fd5b50346101c25760203660031901126101c2576112d7611e3d565b906112e0612366565b6112e8611f2d565b6001600160a01b039283165f818152600483016020819052604090912054600284015492956001600160401b03909116939216851461145e5760058201906001600160401b0384165f52816020528560405f2060018060a01b039054160361144f578394956003941561143b575b5f5260205260405f206001600160401b031981541690556001600160401b0384165f526020528360405f205561138f836006830161277b565b500182815491815b8381106113cd57827fafed6c079ee205fd4c1a084bd8370f11064830354454865a7c6d59b31e3bfc04602087604051908152a180f35b6113d78183611fdb565b905460039190911b1c6001600160a01b0316803b156107b357838091602460405180948193637b66445b60e11b83528b60048401525af19081156107a8578491611426575b5050600101611397565b8161143091611eb9565b6107a457825f61141c565b60088401805460ff60a01b19169055611356565b63febd867360e01b8552600485fd5b63ebf613c160e01b8452600484fd5b50346101c257806003193601126101c25760206001600160a01b036008610386611f2d565b50346101c25760203660031901126101c2576114ac611e3d565b6114b4612366565b6114bc611f2d565b9060018060a01b0381165f52600482016020526001600160401b0360405f205416916001600160401b0383165f526005810160205260405f2063ffffffff6040519161150783611e53565b5460018060a01b038116835260ff8160a01c16602084015260ff8160a81c16604084015260ff8160b01c16606084015260b81c16608082015261154a8483612332565b1561144f57516001600160a01b03908116908316036115b25760020180546001600160a01b0319166001600160a01b039092169190911790556040519081527f385c61a19f2dbdd23a28adf7c6a8ce47b8819680ae11cbb3f69ae3a29f02be8d90602090a180f35b6318f4084560e31b8452600484fd5b50346101c257806003193601126101c257602060016115de611f2d565b0154604051908152f35b50346101c25760203660031901126101c257611602612366565b600435600161160f611f2d565b015580f35b50346101c25760603660031901126101c257600435906001600160401b0382116101c257366023830112156101c257816004013561165181611eda565b9261165f6040519485611eb9565b81845260208401906024829360051b8201019036821161102657602401915b818310611915575050506024356001600160401b0381168091036107a4576044356001600160a01b03811692909190838303611026575f51602061293a5f395f51905f52549360ff8560401c1615946001600160401b0381168015908161190d575b6001149081611903575b1590816118fa575b506118eb5767ffffffffffffffff1981166001175f51602061293a5f395f51905f5255856118bf575b5080156118b05760058751116118a157611733611f2d565b92600184015560088301906bffffffffffffffffffffffff60a01b825416179055600382019551906001600160401b03821161188d57600160401b821161188d578654828855808310611867575b509585526020852095855b82811061184a57505081546fffffffffffffffff000000000000000019166896000000000000000017909155506117eb906117c5612750565b6117cd612750565b6117d5612750565b60015f51602061291a5f395f51905f52556125a5565b6117f25780f35b68ff0000000000000000195f51602061293a5f395f51905f5254165f51602061293a5f395f51905f52557fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2602060405160018152a180f35b81516001600160a01b03168189015560209091019060010161178c565b878752826020882091820191015b8181106118825750611781565b878155600101611875565b634e487b7160e01b86526041600452602486fd5b6310cefe7b60e21b8652600486fd5b6366e7950960e01b8652600486fd5b68ffffffffffffffffff191668010000000000000001175f51602061293a5f395f51905f52555f61171b565b63f92ee8a960e01b8752600487fd5b9050155f6116f2565b303b1591506116ea565b8791506116e0565b82356001600160a01b03811681036109855781526020928301920161167e565b50346101c257806003193601126101c2576040517f0000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc6001600160a01b03168152602090f35b50346101c257806003193601126101c25760206040516301da9c008152f35b50346101c25760203660031901126101c2576119b3611e3d565b60046119bd611f2d565b019060018060a01b03165f5260205260206001600160401b0360405f205416604051908152f35b34610ffa576060366003190112610ffa576119fd611e3d565b60243590611a0961244c565b611a11611f2d565b91611a26611a1d6122f5565b60038501611fdb565b60018060a01b0391549060031b1c169060018060a01b0383165f52600484016020526001600160401b0360405f205416611a608186612332565b15611cfb576001600160401b0381165f526005850160205260405f209060405191611a8a83611e53565b549160018060a01b0383169586825260ff8460a01c16602083015260ff8460a81c16604083015263ffffffff606083019460ff8160b01c16865260b81c16608083015260018060a01b0316809603611cec57611afd610b7891611af6610b6460ff611b04975116612004565b9387612484565b9184612026565b60018501548110611cdd57611b17612540565b611ca857845467ffffffffffffffff1916426001600160401b0316179094555b6044358410611c9957602091611bb6611bc45f938660405182815289888201527fdcbc1c05240f31ff3ad067ef1ee35ce4997762752e3a095284754544f4c709d760403392a36040516323b872dd60e01b8782019081523360248301526001600160a01b03909516604482015260648101919091529182906084820190565b03601f198101835282611eb9565b519082855af115611c73575f513d611c905750803b155b611c7e57507f0000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc6001600160a01b031690813b15610ffa576040516340c10f1960e01b815233600482015260248101829052915f908390604490829084905af1918215611c7357602092611c63575b5060015f51602061291a5f395f51905f5255604051908152f35b5f611c6d91611eb9565b5f611c49565b6040513d5f823e3d90fd5b635274afe760e01b5f5260045260245ffd5b60011415611bdb565b6304a6523360e01b5f5260045ffd5b93611cc89194611cc0611cb961224b565b8093612399565b610bba612540565b9283611b3757633fd3c57f60e21b5f5260045ffd5b631ea30fef60e01b5f5260045ffd5b6318f4084560e31b5f5260045ffd5b63febd867360e01b5f5260045ffd5b34610ffa576020366003190112610ffa57611d23611e27565b611d2b612366565b6105dc6001600160401b0382161015611da157611d46611f2d565b6001600160401b03815416611d89575b50611d5f611f2d565b9067ffffffffffffffff60401b82549160401b169067ffffffffffffffff60401b19161790555f80f35b611d9b90611d9561224b565b90612399565b81611d56565b6345fbd9c160e01b5f5260045ffd5b34610ffa576020366003190112610ffa576020611ddb611dce611e27565b611dd6611f2d565b612332565b6040519015158152f35b34610ffa576020366003190112610ffa576020611e0e6004356003611e08611f2d565b01611fdb565b905460405160039290921b1c6001600160a01b03168152f35b600435906001600160401b0382168203610ffa57565b600435906001600160a01b0382168203610ffa57565b60a081019081106001600160401b03821117611e6e57604052565b634e487b7160e01b5f52604160045260245ffd5b61010081019081106001600160401b03821117611e6e57604052565b604081019081106001600160401b03821117611e6e57604052565b90601f801991011681019081106001600160401b03821117611e6e57604052565b6001600160401b038111611e6e5760051b60200190565b6001600160401b038111611e6e57601f01601f191660200190565b91908203918211611f1957565b634e487b7160e01b5f52601160045260245ffd5b601c6020604051611f3f604082611eb9565b828152017f68797065727661756c742e726f757465722e76312e73746f72616765000000008152205f198101908111611f1957604051906020820190815260208252611f8c604083611eb9565b9051902060ff191690565b63ffffffff6080809260018060a01b03815116855260ff602082015116602086015260ff604082015116604086015260ff6060820151166060860152015116910152565b8054821015611ff0575f5260205f2001905f90565b634e487b7160e01b5f52603260045260245ffd5b60ff166012039060ff8211611f1957565b60ff16604d8111611f1957600a0a90565b81810292918115918404141715611f1957565b91908201809211611f1957565b61204e611f2d565b60028101546001600160a01b03165f9081526004820160209081526040808320546001600160401b03168084526005850190925291829020915190916120f5919061209882611e53565b549260018060a01b038416825260ff8460a01c16602083015260ff8460a81c16604083015263ffffffff606083019460ff8160b01c16865260b81c166080830152610dcc610b6460ff610db56120ec6122f5565b60038a01611fdb565b6120fd612186565b9081156121405761211192610b7891612026565b61211961224b565b90811561213957612130610bad8361213695612610565b90612688565b90565b5050505f90565b505050505f90565b612150611f2d565b61215861224b565b80156121695761216791612399565b565b50805467ffffffffffffffff1916426001600160401b0316179055565b61218e611f2d565b6003810180546002909201545f92839290916001600160a01b0316905b8284106121b9575050505090565b909192936121c78583611fdb565b90546040516370a0823160e01b815260039290921b1c6001600160a01b03166004820152602081602481875afa908115611c73575f91612219575b5061220f90600192612039565b94019291906121ab565b90506020813d8211612243575b8161223360209383611eb9565b81010312610ffa57516001612202565b3d9150612226565b5f906003612257611f2d565b0180545f915b81831061226957505050565b9091936004602061227a8785611fdb565b9054604051637299470360e11b81529384929091839160031b1c6001600160a01b03165afa908115611c73575f916122c3575b506122ba90600192612039565b9401919061225d565b90506020813d82116122ed575b816122dd60209383611eb9565b81010312610ffa575160016122ad565b3d91506122d0565b60036122ff611f2d565b01546001811461232d578015612319576202a30042040690565b634e487b7160e01b5f52601260045260245ffd5b505f90565b906001600160401b03168015612358575f90815260079091016020526040902054151590565b506008015460a01c60ff1690565b5f5160206128fa5f395f51905f52546001600160a01b0316330361238657565b63118cdaa760e01b5f523360045260245ffd5b906123a49082612610565b815467ffffffffffffffff1916426001600160401b0316178255806123c7575050565b6008909101547f0000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc6001600160a01b0390811692911690823b15610ffa576040516340c10f1960e01b81526001600160a01b039290921660048301526024820152905f908290604490829084905af18015611c73576124425750565b5f61216791611eb9565b60025f51602061291a5f395f51905f5254146124755760025f51602061291a5f395f51905f5255565b633ee5aeb560e01b5f5260045ffd5b9190612498575050670de0b6b3a764000090565b608081015160209182015160405163bbc6626160e01b815263ffffffff909216600483015260ff16602482015291829060449082906001600160a01b03165afa908115611c73575f916124e9575090565b90506020813d602011612510575b8161250460209383611eb9565b81010312610ffa575190565b3d91506124f7565b90805f19048211810215670de0b6b3a76400000215610ffa57670de0b6b3a764000091020490565b6040516318160ddd60e01b81526020816004817f0000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc6001600160a01b03165afa908115611c73575f916124e9575090565b815f19048111820215830215610ffa57020490565b5f51602061295a5f395f51905f5280546001600160a01b03199081169091555f5160206128fa5f395f51905f5280549182166001600160a01b0393841690811790915591167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e05f80a3565b9061261e816121369361284e565b9080821015612640575b61263a82612634612540565b92611f0c565b91612688565b80915060011c90612628565b7812725dd1d243aba0e75fe645cc4873f9e65afe688c928e1f218111670de0b6b3a76400000215820215610ffa57670de0b6b3a7640000020490565b815f19048111820215830215610ffa570290808204910615150190565b3d156126cf573d906126b682611ef1565b916126c46040519384611eb9565b82523d5f602084013e565b606090565b81601f82011215610ffa578051906126eb82611ef1565b926126f96040519485611eb9565b82845260208383010111610ffa57815f9260208093018386015e8301015290565b51906001600160401b0382168203610ffa57565b51906001600160a01b0382168203610ffa57565b519060ff82168203610ffa57565b60ff5f51602061293a5f395f51905f525460401c161561276c57565b631afcd79f60e31b5f5260045ffd5b906001820191815f528260205260405f20548015155f14612140575f198101818111611f195782545f19810191908211611f1957818103612803575b505050805480156127ef575f1901906127d08282611fdb565b8154905f199060031b1b19169055555f526020525f6040812055600190565b634e487b7160e01b5f52603160045260245ffd5b6128396128136128239386611fdb565b90549060031b1c92839286611fdb565b819391549060031b91821b915f19901b19161790565b90555f528360205260405f20555f80806127b7565b9080158015612898575b6128925761288d61271091610dd26301da9c009454916001600160401b0361288281851642611f0c565b9360401c1690612026565b040490565b50505f90565b506001600160401b03825416421115612858565b5f82815260018201602052604090205461289257805490600160401b821015611e6e57826128e4612823846001809601855584611fdb565b90558054925f520160205260405f205560019056fe9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c1993009b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00f0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00a264697066735822122026331d4c3c929c3129563bea9636bea775a9c925ea700ded401c70a3cc4d700064736f6c634300081c0033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
0000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc
-----Decoded View---------------
Arg [0] : shareToken_ (address): 0x4bB19336C973506B9405Db586b7AEE302a7CbCFc
-----Encoded View---------------
1 Constructor Arguments found :
Arg [0] : 0000000000000000000000004bb19336c973506b9405db586b7aee302a7cbcfc
Deployed Bytecode Sourcemap
1384:24885:40:-:0;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;3827:4;1384:24885;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;2303:62:31;;:::i;:::-;-1:-1:-1;;;;;;;;;;;1384:24885:40;;-1:-1:-1;;;;;;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;2721:43:30;;;;1384:24885:40;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;2303:62:31;;:::i;:::-;-1:-1:-1;;;;;1384:24885:40;;10804:30;1384:24885;;10877:28;26167:37;;:::i;:::-;10877:28;1384:24885;;-1:-1:-1;;;;;;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;;;3936:5;1384:24885;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;-1:-1:-1;;;;;24565:15:40;26167:37;;:::i;:::-;24565:15;1384:24885;;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;2303:62:31;;:::i;:::-;26167:37:40;;:::i;:::-;11163:5;;;:::i;:::-;;;:::i;:::-;1384:24885;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;19304:23;;1384:24885;;;;;19304:23;;;1384:24885;19304:23;;:::i;:::-;19263:65;;3394:42;19263:65;;;;;:::i;:::-;3394:42;;;;1384:24885;;19404:31;;;1384:24885;19404:31;;3394:42;1384:24885;3394:42;;;;;;1384:24885;19404:31;;3394:42;;-1:-1:-1;;;;;3394:42:40;;;;;;1384:24885;3394:42;;;;;;;1384:24885;;;;;;:::i;:::-;;3394:42;;;-1:-1:-1;;;;;3394:42:40;;;;;1384:24885;3394:42;;;;;;:::i;:::-;;;1384:24885;3394:42;;;-1:-1:-1;;;;;3394:42:40;;;;1384:24885;3394:42;;;;;;;;;;;;;;;;;;:::i;:::-;1384:24885;;;;;;;:::i;:::-;3394:42;;;1384:24885;3394:42;;;;;;;;;;;;;;1384:24885;3394:42;;;;;;;;;;;1384:24885;3394:42;;;;1384:24885;3394:42;;;:::i;:::-;1384:24885;3394:42;;;;1384:24885;3394:42;;;:::i;:::-;1384:24885;3394:42;;;;1384:24885;3394:42;;;:::i;:::-;;1384:24885;3394:42;;;;;;;1384:24885;3394:42;;;:::i;:::-;;1384:24885;3394:42;;;;;1384:24885;3394:42;1384:24885;3394:42;;;:::i;:::-;;1384:24885;3394:42;;;;;;;1384:24885;;;;3394:42;;;;1384:24885;3394:42;;;;-1:-1:-1;;;;;1384:24885:40;;;;;11248:29;1384:24885;;11323:34;;;11373:15;;;1384:24885;;-1:-1:-1;;;;1384:24885:40;-1:-1:-1;;;1384:24885:40;;;11319:201;1384:24885;;;;;;;;;;;;;;;;;;;;;;;12237:9;1384:24885;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;11743:225;;;1384:24885;;;;11743:225;;;1384:24885;;;;;;;;;11743:225;;1384:24885;;;;11743:225;;1384:24885;;;-1:-1:-1;;;;;1384:24885:40;;;-1:-1:-1;1384:24885:40;;;;12015:14;;1384:24885;;;;;;;-1:-1:-1;;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;;;;;;;;3394:42;12064:14;;1384:24885;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;;1384:24885:40;;;;;;;;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;10840:32:28;1384:24885:40;12111:17;;;10840:32:28;:::i;:::-;;12237:9:40;1384:24885;;;12268:13;;12283:7;;;;;;1384:24885;12399:32;1384:24885;;;;;;;;;;;;;;:::i;:::-;12399:32;1384:24885;;12292:3;12329:12;;;;:::i;:::-;1384:24885;;12237:9;1384:24885;;;;;-1:-1:-1;;;;;1384:24885:40;12311:62;;;;;1384:24885;;;12311:62;1384:24885;;;;;;;;;12311:62;;;1384:24885;12311:62;;1384:24885;;;;;;;;:::i;:::-;12311:62;;;;;;;;;;;12292:3;;;1384:24885;;12268:13;;12311:62;;;;;:::i;:::-;1384:24885;;12311:62;;;;1384:24885;;;;12311:62;1384:24885;;;;;;;;;12311:62;1384:24885;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;11319:201;1384:24885;;;;;19928:22;;1384:24885;;;;;19928:22;;;1384:24885;19928:22;;:::i;:::-;19888:63;;3238:42;19888:63;;;;:::i;:::-;3394:42;;;;1384:24885;;20047:30;;;1384:24885;20047:30;;3238:42;1384:24885;3238:42;;;;;;1384:24885;20047:30;;3238:42;;-1:-1:-1;;;;;3238:42:40;;;;;;1384:24885;3238:42;;;;;;;1384:24885;;;;;;:::i;:::-;;3238:42;;;-1:-1:-1;;;;;3238:42:40;;;;;1384:24885;3238:42;;;;;;:::i;:::-;;;;;;;;;;;1384:24885;;;;;;:::i;:::-;3238:42;;1384:24885;3238:42;;;;;;;;1384:24885;3238:42;;;;;;;;;;;;-1:-1:-1;;;1384:24885:40;3238:42;;;;;;-1:-1:-1;;;;;1384:24885:40;20110:33;;;:78;;3238:42;20109:180;;;;3238:42;1384:24885;11319:201;1384:24885;-1:-1:-1;;;1384:24885:40;;;;;20109:180;20210:15;;1384:24885;3238:42;;-1:-1:-1;;;;;1384:24885:40;20210:33;;;-1:-1:-1;20210:33:40;:78;;20109:180;;;;;20210:78;-1:-1:-1;;;;;20247:15:40;;;3238:42;1384:24885;20247:41;20210:78;;;20110;20147:15;;1384:24885;3238:42;;-1:-1:-1;;;;;1384:24885:40;20147:41;;-1:-1:-1;20110:78:40;;3238:42;3394;;;;;1384:24885;3394:42;;;;;;:::i;:::-;3238;;;;;;;;;;;;1384:24885;;;3238:42;1384:24885;;;3238:42;1384:24885;;;3238:42;1384:24885;;;3394:42;-1:-1:-1;;;3394:42:40;;1384:24885;3394:42;;1384:24885;-1:-1:-1;;;1384:24885:40;;;;;3394:42;1384:24885;3394:42;;;;;:::i;:::-;;;;;;;;;;1384:24885;;;3394:42;1384:24885;;;3394:42;1384:24885;;;3394:42;-1:-1:-1;;;3394:42:40;;1384:24885;3394:42;;1384:24885;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;25014:14:40;26167:37;;:::i;:::-;25014:14;:27;1384:24885;-1:-1:-1;1384:24885:40;;;;;-1:-1:-1;1384:24885:40;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;;26167:37;;:::i;:::-;22318:20;22308:31;22318:20;;:::i;:::-;22308:9;;;:31;:::i;:::-;1384:24885;;;;;;;;22308:9;1384:24885;;;22372:21;1384:24885;;;;;;;-1:-1:-1;1384:24885:40;;22372:14;;1384:24885;;-1:-1:-1;;;;;1384:24885:40;-1:-1:-1;1384:24885:40;;;22411:33;;;;;:::i;:::-;1384:24885;;;-1:-1:-1;;;;;1384:24885:40;;-1:-1:-1;1384:24885:40;22520:14;;;1384:24885;;;-1:-1:-1;1384:24885:40;;;;;;;;:::i;:::-;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;22565:28;1384:24885;;;22788:47;22864:32;1384:24885;;;;22731:32;22738:24;1384:24885;22880:15;1384:24885;;;22738:24;:::i;:::-;22731:32;:::i;:::-;22788:47;;:::i;:::-;1384:24885;;;22880:15;:::i;:::-;22864:32;;:::i;:::-;22911:14;;;:::i;:::-;;;22946:17;1384:24885;;;;;;22907:254;23097:53;23009:5;23117:26;23048;23009:5;;:::i;:::-;23048:26;;;:::i;:::-;23117:14;;:::i;:::-;:26;:::i;:::-;23097:53;;:::i;:::-;22907:254;;1384:24885;-1:-1:-1;;;1384:24885:40;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;26167:37:40;;:::i;:::-;1384:24885;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;3361:103:34;;:::i;:::-;3426:1;;:::i;:::-;1949;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;3361:103:34;;;:::i;:::-;26167:37:40;;:::i;:::-;7615:10;;1384:24885;;7666:15;;;1384:24885;;7666:15;;;-1:-1:-1;;;;;1384:24885:40;7666:29;1384:24885;;8341:35;7807:39;7745:5;;:::i;:::-;7772:4;;;;:::i;:::-;7831:14;;:::i;:::-;7807:39;;;:::i;:::-;1384:24885;;;;;;;;;;;;;;-1:-1:-1;1384:24885:40;;7930:14;;1384:24885;;8362:13;-1:-1:-1;;;;;1384:24885:40;-1:-1:-1;1384:24885:40;;;8001:27;-1:-1:-1;;;;;1384:24885:40;;-1:-1:-1;1384:24885:40;8001:14;;;1384:24885;;8275:47;1384:24885;-1:-1:-1;1384:24885:40;8159:9;1384:24885;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8159:9;8169:20;8218:32;8225:24;1384:24885;8159:31;8169:20;;:::i;:::-;8159:31;;:::i;:::-;1384:24885;;;;;;;;8159:9;1384:24885;;;;;;8225:24;:::i;8218:32::-;8275:47;;:::i;:::-;8362:13;:::i;:::-;8341:35;;:::i;:::-;8394:10;;;1384:24885;;;;8445:16;;1384:24885;;;;;;;;;;;;8506:34;1384:24885;8513:10;8506:34;;8654:11;-1:-1:-1;;;;;1384:24885:40;;8636:59;;;;;1384:24885;;-1:-1:-1;;;8636:59:40;;8513:10;1384:24885;8636:59;;1384:24885;;;;;;;;;;;;;;;;;;;8636:59;;;;;;;;;;;1384:24885;15063:26;;;1384:24885;;;15233:13;;15248:7;;;;;;15228:575;15873:14;;;;1384:24885;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;15257:3;15300:12;;;;:::i;:::-;1384:24885;;;;;;-1:-1:-1;;;15350:48:40;;8159:9;1384:24885;;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;15350:48;;1384:24885;;;;;;;;;;15350:48;;;;;;;;;;;15257:3;3463:5:25;;;;3066;;;1384:24885:40;3060:42:25;;;15490:18:40;;15486:268;;15257:3;15771:14;;;;;15767:25;;1384:24885;;15233:13;;15767:25;15787:5;;15486:268;15603:91;;;;;;;;;1384:24885;;-1:-1:-1;;;15603:91:40;;-1:-1:-1;;;;;1384:24885:40;;;;;15603:91;;1384:24885;8513:10;1384:24885;;;;;;;;;;;;;;;;;;;;;15603:91;;;;;;;;;;;15486:268;15712:27;;;;;;:::i;:::-;15486:268;;;;;;15603:91;;;;;:::i;:::-;1384:24885;;15603:91;;;;;1384:24885;;;;;;;;;15603:91;1384:24885;;;15350:48;;;;1384:24885;15350:48;;;;;;;;;1384:24885;15350:48;;;:::i;:::-;;;1384:24885;;;;;15350:48;;;;1384:24885;-1:-1:-1;1384:24885:40;;15350:48;;;-1:-1:-1;15350:48:40;;;1384:24885;;;;;;;;;8636:59;;;;;:::i;:::-;1384:24885;;8636:59;;;;;1384:24885;;;;-1:-1:-1;;;1384:24885:40;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;-1:-1:-1;;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;966:10:33;-1:-1:-1;;;;;1384:24885:40;;;3352:24:30;3348:96;;3472:6;966:10:33;3472:6:30;:::i;:::-;1384:24885:40;;3348:96:30;-1:-1:-1;;;3399:34:30;;966:10:33;1384:24885:40;;;;3399:34:30;1384:24885:40;;;;;;;;;;;;;2303:62:31;;:::i;:::-;-1:-1:-1;;;;;;;;;;;1384:24885:40;;-1:-1:-1;;;;;;1384:24885:40;;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;;;;;;-1:-1:-1;;;;;1384:24885:40;3975:40:31;1384:24885:40;;3975:40:31;1384:24885:40;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;4134:182;;:::i;1384:24885::-;;;;;;;;;;;;;;-1:-1:-1;;;;;26167:37:40;;:::i;:::-;1384:24885;;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;26167:37;;:::i;:::-;23316:10;;;1384:24885;;23367:15;;;1384:24885;-1:-1:-1;;;;;1384:24885:40;;23367:29;;1384:24885;;;24142:35;23446:5;24163:13;23446:5;23603:44;23446:5;;;:::i;:::-;23547:26;23481;;;;:::i;23547:::-;23603:44;;:::i;:::-;23731:31;1384:24885;;;;;;-1:-1:-1;1384:24885:40;;23731:14;;1384:24885;;24076:47;-1:-1:-1;;;;;1384:24885:40;-1:-1:-1;1384:24885:40;;;-1:-1:-1;;;;;1384:24885:40;;-1:-1:-1;1384:24885:40;23802:14;;;1384:24885;;;-1:-1:-1;1384:24885:40;;24019:32;24026:24;1384:24885;23960:31;1384:24885;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;23960:9;23970:20;;:::i;:::-;23960:9;;:31;:::i;1384:24885::-;-1:-1:-1;;;1384:24885:40;;;;;;-1:-1:-1;;;;;;1384:24885:40;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;2303:62:31;;;:::i;:::-;26167:37:40;;:::i;:::-;-1:-1:-1;;;;;1384:24885:40;;;-1:-1:-1;1384:24885:40;;;;12640:14;;1384:24885;;;;;;;;;12758:15;;;1384:24885;;;-1:-1:-1;;;;;1384:24885:40;;;;12640:14;1384:24885;12749:24;;1384:24885;;12879:14;;;:27;-1:-1:-1;;;;;1384:24885:40;;-1:-1:-1;1384:24885:40;;;;;;-1:-1:-1;1384:24885:40;;;;;;;;;12879:48;1384:24885;;12978:34;;;1384:24885;12978:34;;12974:63;;1384:24885;-1:-1:-1;1384:24885:40;;;;-1:-1:-1;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;;;;;;-1:-1:-1;;;;;1384:24885:40;;-1:-1:-1;1384:24885:40;;;;;-1:-1:-1;1384:24885:40;;11140:35:28;13129:17:40;;;;11140:35:28;:::i;:::-;;13191:9:40;1384:24885;;;13222:13;;13237:7;;;;;;1384:24885;13347:25;1384:24885;;;;;;;13347:25;1384:24885;;13246:3;13283:12;;;;:::i;:::-;1384:24885;;;;;;;;-1:-1:-1;;;;;1384:24885:40;13265:56;;;;;1384:24885;;;13265:56;1384:24885;;;;;;;;;13265:56;;;1384:24885;13265:56;;1384:24885;13265:56;;;;;;;;;;;13246:3;;;1384:24885;;13222:13;;13265:56;;;;;:::i;:::-;1384:24885;;13265:56;;;;12974:63;13014:15;;;1384:24885;;-1:-1:-1;;;;1384:24885:40;;;12974:63;;1384:24885;-1:-1:-1;;;1384:24885:40;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;25821:14:40;26167:37;;:::i;1384:24885::-;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;2303:62:31;;:::i;:::-;26167:37:40;;:::i;:::-;13577:21;1384:24885;;;;;;;-1:-1:-1;1384:24885:40;;13577:14;;1384:24885;;-1:-1:-1;;;;;1384:24885:40;-1:-1:-1;1384:24885:40;;;13638:27;-1:-1:-1;;;;;1384:24885:40;;-1:-1:-1;1384:24885:40;13638:14;;;1384:24885;;;-1:-1:-1;1384:24885:40;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;13684:33;;;;:::i;:::-;1384:24885;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;13771:28;1384:24885;;13841:15;;1384:24885;;-1:-1:-1;;;;;;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;13879:33;;1384:24885;;13879:33;1384:24885;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;;;;;;;;;;;25628:17;26167:37;;:::i;:::-;25628:17;1384:24885;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;2303:62:31;;:::i;:::-;1384:24885:40;;;26167:37;;:::i;:::-;10597:31;1384:24885;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;;;;4301:16:32;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;;4726:16:32;;:34;;;;1384:24885:40;4805:1:32;4790:16;:50;;;;1384:24885:40;4855:13:32;:30;;;;1384:24885:40;4851:91:32;;;-1:-1:-1;;1384:24885:40;;4805:1:32;1384:24885:40;-1:-1:-1;;;;;;;;;;;1384:24885:40;;4979:67:32;;1384:24885:40;4813:20;;;1384:24885;;;;;4931:20;1384:24885;;26167:37;;:::i;:::-;5042:17;4805:1:32;5042:17:40;;1384:24885;5083:14;;;1384:24885;;;;;;;;;;5154:9;;;1384:24885;;;-1:-1:-1;;;;;1384:24885:40;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;-1:-1:-1;;1384:24885:40;;;;;;-1:-1:-1;5381:6:40;;6893:76:32;;:::i;:::-;;;:::i;:::-;;;:::i;:::-;4805:1;-1:-1:-1;;;;;;;;;;;1384:24885:40;5381:6;:::i;:::-;5066:101:32;;1384:24885:40;;5066:101:32;1384:24885:40;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;-1:-1:-1;;;;;;;;;;;1384:24885:40;5142:14:32;1384:24885:40;;;4805:1:32;1384:24885:40;;5142:14:32;1384:24885:40;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;4805:1:32;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4805:1:32;1384:24885:40;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;-1:-1:-1;;;1384:24885:40;;;;;4979:67:32;-1:-1:-1;;1384:24885:40;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;4979:67:32;;;4851:91;-1:-1:-1;;;4908:23:32;;1384:24885:40;4908:23:32;;4855:30;4872:13;;;4855:30;;;4790:50;4818:4;4810:25;:30;;-1:-1:-1;4790:50:32;;4726:34;;;-1:-1:-1;4726:34:32;;1384:24885:40;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;3697:36;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;4031:8;1384:24885;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;;26167:37;;:::i;:::-;24367:14;:21;1384:24885;;;;;;-1:-1:-1;1384:24885:40;;;;-1:-1:-1;;;;;1384:24885:40;-1:-1:-1;1384:24885:40;;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;;;3361:103:34;;;:::i;:::-;26167:37:40;;:::i;:::-;6052:20;6042:31;6052:20;;:::i;:::-;6042:9;;;:31;:::i;:::-;1384:24885;;;;;;;;6042:9;1384:24885;;;6106:21;1384:24885;;;;;;;;;;6106:14;;1384:24885;;-1:-1:-1;;;;;1384:24885:40;;;;;6145:33;;;;:::i;:::-;1384:24885;;;-1:-1:-1;;;;;1384:24885:40;;;;6254:14;;;1384:24885;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6299:28;;;1384:24885;;6522:47;6614:15;1384:24885;6465:32;6472:24;1384:24885;6598:32;1384:24885;;;6472:24;:::i;6465:32::-;6522:47;;;:::i;:::-;6614:15;;;:::i;6598:32::-;1384:24885;6660:17;;1384:24885;6648:29;;1384:24885;;6722:14;;:::i;:::-;;;1384:24885;;-1:-1:-1;;1384:24885:40;6826:15;-1:-1:-1;;;;;1384:24885:40;;;;;6718:336;1384:24885;;7072:16;;1384:24885;;;;1745:53:13;;1384:24885:40;;;;;;;;;;;;;7133:42;1384:24885;7141:10;7133:42;;1384:24885;;-1:-1:-1;;;1745:53:13;;;;;;7141:10:40;1384:24885;1745:53:13;;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;1745:53:13;;;;;;;;;;:::i;:::-;7823:421;;;;;;;;;1384:24885:40;7823:421:13;;8258:15;;8276:26;;;:31;8258:68;8254:146;;-1:-1:-1;7358:11:40;-1:-1:-1;;;;;1384:24885:40;;7340:55;;;;;1384:24885;;-1:-1:-1;;;7340:55:40;;7141:10;1384:24885;7340:55;;1384:24885;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;-1:-1:-1;;7340:55:40;;;;;;;1384:24885;7340:55;;;8258:68:13;1384:24885:40;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;;;;7340:55;1384:24885;7340:55;;;:::i;:::-;1384:24885;7340:55;;;1384:24885;;;;;;;;;8254:146:13;8349:40;;;1384:24885:40;8349:40:13;1384:24885:40;;;;8349:40:13;8258:68;1384:24885:40;8310:16:13;;8258:68;;1384:24885:40;;;;;;;;;6718:336;6888:5;6947:41;6888:5;;6919:4;6888:5;;:::i;:::-;6919:4;;;:::i;:::-;6967:14;;:::i;6947:41::-;7010:10;;6718:336;1384:24885;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;2303:62:31;;:::i;:::-;3827:4:40;-1:-1:-1;;;;;1384:24885:40;;10168:40;1384:24885;;;26167:37;;:::i;:::-;-1:-1:-1;;;;;1384:24885:40;;;10290:82;;1384:24885;26167:37;;;:::i;:::-;1384:24885;-1:-1:-1;;;1384:24885:40;;;;;;;-1:-1:-1;;;1384:24885:40;;;;;;;;10290:82;10355:5;;;;:::i;:::-;;;:::i;:::-;10290:82;;;1384:24885;;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;24775:33;1384:24885;;:::i;:::-;26167:37;;:::i;:::-;24775:33;:::i;:::-;1384:24885;;;;;;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;20669:16;1384:24885;;20669:9;26167:37;;:::i;:::-;20669:9;:16;:::i;:::-;1384:24885;;;;20669:9;1384:24885;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;:::o;:::-;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;:::o;:::-;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;:::o;:::-;;;;-1:-1:-1;1384:24885:40;;;;;-1:-1:-1;1384:24885:40;;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;:::o;:::-;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;:::o;:::-;;;1745:53:13;;1384:24885:40;;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;:::o;:::-;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;:::o;:::-;-1:-1:-1;;;;;1384:24885:40;;;;;;-1:-1:-1;;1384:24885:40;;;;:::o;:::-;;;;;;;;;;:::o;:::-;;;;;;;;;;;;4134:182;1384:24885;;;;;;;;:::i;:::-;;;;;;;;4235:48;1384:24885;;;;;;;;;;;4216:73;1384:24885;4216:73;;1384:24885;;;;4216:73;;;1384:24885;4216:73;;:::i;:::-;1384:24885;;4206:84;;-1:-1:-1;;4206:110:40;;4134:182::o;1384:24885::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;-1:-1:-1;1384:24885:40;;-1:-1:-1;1384:24885:40;;;-1:-1:-1;1384:24885:40;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;:::o;21127:979::-;26167:37;;:::i;:::-;21286:15;;;1384:24885;-1:-1:-1;;;;;1384:24885:40;-1:-1:-1;1384:24885:40;;;21271:14;;;1384:24885;;;;;;;;;-1:-1:-1;;;;;1384:24885:40;;;;21342:14;;;1384:24885;;;;;;;;;;;21616:47;;1384:24885;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;21559:32;21566:24;1384:24885;21500:31;21510:20;;:::i;:::-;21500:9;;;:31;:::i;21616:47::-;21695:17;;:::i;:::-;21726:16;;;21722:30;;21874:37;21897:13;;;;:::i;21874:37::-;21936:5;;:::i;:::-;21955:9;;;21951:23;;22066:26;22005;;22048:51;22005:26;;:::i;22066:::-;22048:51;;:::i;:::-;21127:979;:::o;21951:23::-;21966:8;;;1384:24885;21966:8;:::o;21722:30::-;21744:8;;;;1384:24885;21744:8;:::o;9552:276::-;26167:37;;:::i;:::-;9666:5;;:::i;:::-;9685:9;;9681:114;;9816:4;;;:::i;:::-;9552:276::o;9681:114::-;-1:-1:-1;1384:24885:40;;-1:-1:-1;;1384:24885:40;9748:15;-1:-1:-1;;;;;1384:24885:40;;;;9778:7::o;20732:355::-;26167:37;;:::i;:::-;20904:9;;;1384:24885;;21001:15;;;;1384:24885;20878:1;;;;1384:24885;;-1:-1:-1;;;;;1384:24885:40;;20950:7;;;;;;21061:19;;;;20732:355;:::o;20959:3::-;21028:12;;;;;;;;:::i;:::-;1384:24885;;;;-1:-1:-1;;;20994:47:40;;20904:9;1384:24885;;;;;-1:-1:-1;;;;;1384:24885:40;20994:47;;;1384:24885;20994:47;1384:24885;20994:47;1384:24885;20994:47;;;;;;;;20878:1;20994:47;;;20959:3;20978:63;;;1384:24885;20978:63;;:::i;:::-;20959:3;1384:24885;20935:13;;;;;20994:47;;;;;;;;;;;;;1384:24885;20994:47;;;:::i;:::-;;;1384:24885;;;;;;20994:47;;;;;-1:-1:-1;20994:47:40;;8788:267;1384:24885;26167:37;8919:9;26167:37;;:::i;:::-;8919:9;1384:24885;;;8945:104;8965:7;;;;;;8788:267;;;:::o;8974:3::-;9019:12;;;9001:37;;9019:12;;;;:::i;:::-;1384:24885;;;;-1:-1:-1;;;9001:37:40;;1384:24885;;;;;;;8919:9;1384:24885;;-1:-1:-1;;;;;1384:24885:40;9001:37;;;;;;;1384:24885;9001:37;;;8974:3;8993:45;;;1384:24885;8993:45;;:::i;:::-;8974:3;1384:24885;8950:13;;;;9001:37;;;;;;;;;;;;;1384:24885;9001:37;;;:::i;:::-;;;1384:24885;;;;;;9001:37;;;;;-1:-1:-1;9001:37:40;;9099:236;9192:23;26167:37;;:::i;:::-;9192:23;1384:24885;9243:1;9236:8;;9232:47;;1384:24885;;;;9315:6;9297:15;1384:24885;;9099:236;:::o;1384:24885::-;;;;;;;;;;;;9232:47;9260:8;1384:24885;9260:8;:::o;18686:232::-;;-1:-1:-1;;;;;1384:24885:40;18797:34;;18793:62;;-1:-1:-1;1384:24885:40;;;4360:14:28;;;;1384:24885:40;;;;;;4360:26:28;;21127:979:40;:::o;18793:62::-;-1:-1:-1;18840:15:40;;1384:24885;;;;;;18833:22::o;2658:162:31:-;-1:-1:-1;;;;;;;;;;;1384:24885:40;-1:-1:-1;;;;;1384:24885:40;966:10:33;2717:23:31;2713:101;;2658:162::o;2713:101::-;3399:34:30;;;-1:-1:-1;2763:40:31;966:10:33;2763:40:31;1384:24885:40;;-1:-1:-1;2763:40:31;16138:446:40;;16239:33;16138:446;16239:33;;:::i;:::-;1384:24885;;-1:-1:-1;;1384:24885:40;16439:15;-1:-1:-1;;;;;1384:24885:40;;;;16470:16;16466:112;;16138:446;;:::o;16466:112::-;16538:14;;;;1384:24885;16520:11;-1:-1:-1;;;;;1384:24885:40;;;;;;;16502:65;;;;;1384:24885;;-1:-1:-1;;;16502:65:40;;-1:-1:-1;;;;;1384:24885:40;;;;16502:65;;;1384:24885;;;;;;-1:-1:-1;;1384:24885:40;;;;;;-1:-1:-1;;16502:65:40;;;;;;;;16138:446;:::o;16502:65::-;16401:28;16502:65;;;:::i;3470:384:34:-;1991:1;-1:-1:-1;;;;;;;;;;;1384:24885:40;3670:20:34;3666:88;;1991:1;-1:-1:-1;;;;;;;;;;;1384:24885:40;3470:384:34:o;3666:88::-;3713:30;;;-1:-1:-1;3713:30:34;;-1:-1:-1;3713:30:34;14428:332:40;;;14653:34;;14652:101;;14691:4;14428:332;:::o;14652:101::-;14714:18;;;1384:24885;14734:18;;;;1384:24885;;;-1:-1:-1;;;14698:55:40;;1384:24885;;;;14698:55;;;1384:24885;;;;;;;;;;14698:55;;1384:24885;;-1:-1:-1;;;;;1384:24885:40;14698:55;;;;;;;3578:1;14698:55;;;14652:101;14428:332;:::o;14698:55::-;;;14734:18;14698:55;;14734:18;14698:55;;;;;;1384:24885;14698:55;;;:::i;:::-;;;1384:24885;;;;;14428:332;:::o;14698:55::-;;;-1:-1:-1;14698:55:40;;704:164:36;;1384:24885:40;;;1744:340:36;;;;;;655:4;1744:340;;;;655:4;1744:340;;;704:164;:::o;16718:113:40:-;1384:24885;;-1:-1:-1;;;16791:33:40;;;1384:24885;16791:33;1384:24885;16798:11;-1:-1:-1;;;;;1384:24885:40;16791:33;;;;;;;-1:-1:-1;16791:33:40;;;16784:40;16718:113;:::o;1564:526:36:-;1384:24885:40;;;1744:340:36;;;;;;;;;;;;;1564:526;:::o;2955:222:30:-;-1:-1:-1;;;;;;;;;;;1384:24885:40;;-1:-1:-1;;;;;;1384:24885:40;;;;;;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;;-1:-1:-1;;;;;1384:24885:40;;;;;;;;;;;3975:40:31;-1:-1:-1;;3975:40:31;2955:222:30:o;17166:426:40:-;;17292:22;17166:426;17529:56;17166:426;17292:22;:::i;:::-;17444:19;;;;;17440:72;;17166:426;17566:18;17550:14;;;:::i;:::-;17566:18;;:::i;:::-;17529:56;;:::i;17440:72::-;1384:24885;;;;;17440:72;;;1038:164:36;1744:340;;;655:4;1744:340;;;;;;;655:4;1744:340;;1038:164;:::o;2096:672::-;1384:24885:40;;;2274:488:36;;;;;;;;;;;;;;;;;;;;;2096:672;:::o;3394:42:40:-;;;;;;1384:24885;;;;:::i;:::-;;;;;;;;:::i;:::-;;;3394:42;-1:-1:-1;3394:42:40;;;;:::o;:::-;1384:24885;3394:42;:::o;:::-;;;;;;;;;;;;;;;:::i;:::-;1384:24885;;;;;;;:::i;:::-;3394:42;;;;;;;;;;;;-1:-1:-1;3394:42:40;;;;;;;;;;;;;;:::o;:::-;;1384:24885;-1:-1:-1;;;;;1384:24885:40;;;;;;3394:42::o;:::-;;;-1:-1:-1;;;;;1384:24885:40;;;;;;3394:42::o;:::-;;1384:24885;;;;3394:42;;;;:::o;7084:141:32:-;1384:24885:40;-1:-1:-1;;;;;;;;;;;1384:24885:40;;;;7150:18:32;7146:73;;7084:141::o;7146:73::-;7191:17;;;-1:-1:-1;7191:17:32;;-1:-1:-1;7191:17:32;2815:1368:28;;3010:14;;;1384:24885:40;;;;;;;;;;;3046:13:28;;;3042:1135;3046:13;;;-1:-1:-1;;1384:24885:40;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;;;3521:23:28;;;3517:378;;3042:1135;1384:24885:40;;;;;;;;;-1:-1:-1;;1384:24885:40;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;3010:14:28;4112:11;:::o;1384:24885:40:-;;;;;;;;;;;;3517:378:28;1384:24885:40;3584:22:28;3705:23;3584:22;;;:::i;:::-;1384:24885:40;;;;;;3705:23:28;;;;;:::i;:::-;1384:24885:40;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;3517:378:28;;;;;17871:570:40;;17993:16;;:67;;;;17871:570;17989:106;;18330:46;3936:5;1384:24885;18330:32;4031:8;1384:24885;;;-1:-1:-1;;;;;18187:46:40;1384:24885;;;18187:15;:46;:::i;:::-;1384:24885;;;;18330:32;;:::i;:46::-;1384:24885;;17871:570;:::o;17989:106::-;18076:8;;1384:24885;18076:8;:::o;17993:67::-;1384:24885;-1:-1:-1;;;;;1384:24885:40;;;18013:15;:47;;17993:67;;2241:406:28;-1:-1:-1;1384:24885:40;;;4360:14:28;;;1384:24885:40;;;;;;2325:21:28;;1384:24885:40;;;-1:-1:-1;;;1384:24885:40;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;2520:14:28;1384:24885:40;;;;;;;2576:11:28;:::o
Swarm Source
ipfs://26331d4c3c929c3129563bea9636bea775a9c925ea700ded401c70a3cc4d7000
Loading...
Loading
Loading...
Loading
Loading...
Loading
0x893C6e4f1e17dB74742a9907c8E22491b0CEA8F0
Net Worth in USD
$0.00
Net Worth in HYPE
0
Multichain Portfolio | 35 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
Loading...
Loading
Loading...
Loading
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.