Address Contract Partially Verified
Address
0xFF630c5d2FB9920C29C264b85e968D435F07e293
Balance
0 ETH
Nonce
10
Code Size
6671 bytes
Creator
0xba5Ed099...a5Ed at tx 0x5c828b52...2d227a
Indexed Transactions
0
Contract Bytecode
6671 bytes
0x60806040526004361015610011575f80fd5b5f5f3560e01c8063168cd75414610f76578063184ffaa514610db55780633f4ba83a14610ef657806340e274cc14610e9557806353e78b6b14610e235780635c975abb14610df4578063652b9b4114610db5578063715018a614610d4c5780637fdaa55b14610af35780638456cb5914610a805780638da5cb5b14610a4b5780639094a91e146109ca5780639225a1111461087b578063ad5c464814610854578063b4e25e80146107d3578063ba2b9b1614610723578063bba48a90146106fa578063c9c14d75146105d5578063ca0ab075146105ac578063cfd3c73d14610378578063f2fde38b146103505763f8c8765e1461010c575f80fd5b3461034d57608036600319011261034d576101256110d2565b6024356001600160a01b0381169081900361034b576044356001600160a01b03811690819003610347576064356001600160a01b0381169290839003610343575f5160206119e35f395f51905f52549360ff8560401c1615946001600160401b0381168015908161033b575b6001149081610331575b159081610328575b506103195767ffffffffffffffff1981166001175f5160206119e35f395f51905f5255856102ed575b506001600160a01b0381161515806102e4575b806102db575b806102d2575b156102c357610209906101fc611977565b610204611977565b6113a6565b610211611977565b610219611977565b60ff195f5160206119c35f395f51905f5254165f5160206119c35f395f51905f525560018060a01b031985541617845560018060a01b0319600154161760015560018060a01b031960025416176002556102705780f35b60ff60401b195f5160206119e35f395f51905f5254165f5160206119e35f395f51905f52557fc7f505b2f371ae2175ee4913f4499e1f2633a7b5936321eed1cdaeb6115181d2602060405160018152a180f35b63d92e233d60e01b8652600486fd5b508315156101eb565b508215156101e5565b508115156101df565b68ffffffffffffffffff191668010000000000000001175f5160206119e35f395f51905f52555f6101cc565b63f92ee8a960e01b8752600487fd5b9050155f6101a3565b303b15915061019b565b879150610191565b8480fd5b8380fd5b825b80fd5b503461034d57602036600319011261034d5761037561036d6110d2565b6102046118b1565b80f35b503461034d57606036600319011261034d576004356001600160401b0381116105a8576103a99036906004016112a7565b6024356001600160401b038111610347576103c89036906004016112a7565b90916044356001600160401b0381116105a4576103e99036906004016112d7565b916103f26118b1565b80820361059557825182036105955790859291835b828110610412578480f35b6104386001600160a01b0361043061042b84878c611334565b611344565b161515611358565b6001600160a01b0361044e61042b83868b611334565b16610484602061045f84868b611334565b604051627eeac760e11b81523060048201529035602482015291829081906044820190565b0381855afa90811561058a578791610552575b50806104a38488611392565b5111610541575b506104b6828489611334565b356104c18387611392565b51823b1561053d5760c48892836040519586948593637921219560e11b85523060048601523360248601526044850152606484015260a060848401528160a48401525af190811561053257869161051d575b5050600101610407565b8161052791611042565b61034357845f610513565b6040513d88823e3d90fd5b8780fd5b61054b8387611392565b525f6104aa565b9650506020863d8211610582575b8161056d60209383611042565b8101031261057e578895515f610497565b5f80fd5b3d9150610560565b6040513d89823e3d90fd5b63512509d360e11b8652600486fd5b8580fd5b5080fd5b503461034d578060031936011261034d576001546040516001600160a01b039091168152602090f35b503461034d57604036600319011261034d576004356001600160401b0381116105a8576106069036906004016112a7565b6024356001600160401b038111610347576106259036906004016112a7565b9290916106306118b1565b8381036106eb5790849291835b818110610648578480f35b6106616001600160a01b0361043061042b848688611334565b6001600160a01b0361067761042b838587611334565b16610683828887611334565b3590803b156106e757604051632142170760e11b8152306004820152336024820152604481019290925286908290606490829084905af19081156105325786916106d2575b505060010161063d565b816106dc91611042565b61034357845f6106c8565b8680fd5b63512509d360e11b8552600485fd5b503461034d578060031936011261034d576002546040516001600160a01b039091168152602090f35b503461034d57602036600319011261034d57808080806004356107446118b1565b478082116107cb575b50335af13d156107c6573d61076181611063565b9061076f6040519283611042565b81528260203d92013e5b156107815780f35b60405162461bcd60e51b815260206004820152601b60248201527f4661696c656420746f2073656e64206e617469766520746f6b656e00000000006044820152606490fd5b610779565b90505f61074d565b503461034d57602036600319011261034d576107ed6110d2565b6107f56118b1565b6001600160a01b0316801561084557600180546001600160a01b031916821790556040519081527ff96974158959e95a21cb52b8ea5c0d8069c4c441e428137669ec305940dc1d1890602090a180f35b63d92e233d60e01b8252600482fd5b503461034d578060031936011261034d57546040516001600160a01b039091168152602090f35b503461034d57604036600319011261034d576004356001600160401b0381116105a8576108ac9036906004016112a7565b6024356001600160401b038111610347576108cb9036906004016112d7565b916108d46118b1565b825182036109bb57835b8281106108e9578480f35b6109026001600160a01b0361043061042b848787611334565b6001600160a01b0361091861042b838686611334565b16906040516370a0823160e01b8152306004820152602081602481865afa90811561058a578791610989575b506001928161097292610957858a611392565b5111610978575b506109698388611392565b519033906118e4565b016108de565b6109828489611392565b525f61095e565b90506020813d82116109b3575b816109a360209383611042565b8101031261057e57516001610944565b3d9150610996565b63512509d360e11b8452600484fd5b503461034d57602036600319011261034d576004359060045482101561034d57600454821015610a3757600481527f8a35acfbc15ff81a39ae7d344fd709f28e8600b4aa8c65c6b64bfe7fe36bd19b9091015460405160039290921b1c6001600160a01b03168152602090f35b634e487b7160e01b81526032600452602490fd5b503461034d578060031936011261034d575f5160206119a35f395f51905f52546040516001600160a01b039091168152602090f35b503461034d578060031936011261034d57610a996118b1565b610aa1611417565b600160ff195f5160206119c35f395f51905f525416175f5160206119c35f395f51905f52557f62e78cea01bee320cd4e420270b5ea74000d11b0c9f74754ebdbfc544b05a2586020604051338152a180f35b50608036600319011261034d576004356001600160401b0381116105a857610b1f903690600401611113565b816024356001600160401b0381116105a857366023820112156105a8578060040135906001600160401b03821161034b5736602460a084028301011161034b576044356001600160a01b0381169490859003610347576064356001600160401b0381116103435736602382011215610343578060040135916001600160401b0383116105a45736602484840101116105a457610bb9611417565b6001600160a01b0390610bcb9061152d565b1695863b156105a4579391859391604051958694632578f7af60e21b865280608487016080600489015252602460a48701950190875b818110610cd057505050918060246020959387958287015288604487015260031986860301606487015282855201858401378181018401869052601f01601f19160103018183875af18015610cc557610cb0575b5050803b156105a85760405163f2fde38b60e01b8152336004820152828160248183865af18015610ca557610c90575b602082604051908152f35b610c9b838092611042565b6105a85781610c85565b6040513d85823e3d90fd5b81610cba91611042565b6105a857815f610c55565b6040513d84823e3d90fd5b9294965092949080975035906003821015610d485790815260019060a09081906001600160a01b03610d0460208c016110e8565b1660208201528380831b03610d1b60408c016110e8565b16604082015260608a0135606082015260808a013560808201520197019101908896949288969492610c01565b8980fd5b503461034d578060031936011261034d57610d656118b1565b5f5160206119a35f395f51905f5280546001600160a01b0319811690915581906001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a380f35b503461034d57602036600319011261034d5760209060ff906040906001600160a01b03610de06110d2565b168152600584522054166040519015158152f35b503461034d578060031936011261034d57602060ff5f5160206119c35f395f51905f5254166040519015158152f35b503461034d57602036600319011261034d57610e3d6110d2565b610e456118b1565b6001600160a01b0316801561084557600280546001600160a01b031916821790556040519081527fbdd9d70e247e204f3a2fdc76dac537ab22655589149095edf3db28d50d7baafa90602090a180f35b503461034d57604036600319011261034d57610eaf6110d2565b6001600160a01b031681526003602052604081208054602435929083101561034d576020610edd848461127e565b905460405160039290921b1c6001600160a01b03168152f35b503461034d578060031936011261034d57610f0f6118b1565b5f5160206119c35f395f51905f525460ff811615610f675760ff19165f5160206119c35f395f51905f52557f5db9ee0a495bf2e6ff9c91a7834c1ba4fdd244a5e8aa4e537bd38aeae4b073aa6020604051338152a180f35b638dfc202b60e01b8252600482fd5b602036600319011261057e576004356001600160401b03811161057e57610fa1903690600401611113565b610fa9611417565b6001600160a01b0390610fbb9061152d565b16803b1561057e5760405163f2fde38b60e01b8152336004820152905f8260248183855af191821561100857602092610ff8575b50604051908152f35b5f61100291611042565b5f610fef565b6040513d5f823e3d90fd5b60a081019081106001600160401b0382111761102e57604052565b634e487b7160e01b5f52604160045260245ffd5b90601f801991011681019081106001600160401b0382111761102e57604052565b6001600160401b03811161102e57601f01601f191660200190565b81601f8201121561057e5780359061109582611063565b926110a36040519485611042565b8284526020838301011161057e57815f926020809301838601378301015290565b359060ff8216820361057e57565b600435906001600160a01b038216820361057e57565b35906001600160a01b038216820361057e57565b6001600160401b03811161102e5760051b60200190565b919060a08382031261057e5760405161112b81611013565b809380356001600160401b03811161057e578361114991830161107e565b825260208101356001600160401b03811161057e578361116a91830161107e565b602083015260408101356040830152606081013561ffff8116810361057e5760608301526080810135906001600160401b03821161057e57019160a08382031261057e57604051926111bb84611013565b8035801515810361057e5784526111d4602082016110c4565b60208501526111e5604082016110c4565b60408501526111f6606082016110e8565b60608501526080810135906001600160401b03821161057e57019080601f8301121561057e578135611227816110fc565b926112356040519485611042565b81845260208085019260051b82010192831161057e57602001905b8282106112665750505090608091828401520152565b60208091611273846110e8565b815201910190611250565b8054821015611293575f5260205f2001905f90565b634e487b7160e01b5f52603260045260245ffd5b9181601f8401121561057e578235916001600160401b03831161057e576020808501948460051b01011161057e57565b9080601f8301121561057e5781356112ee816110fc565b926112fc6040519485611042565b81845260208085019260051b82010192831161057e57602001905b8282106113245750505090565b8135815260209182019101611317565b91908110156112935760051b0190565b356001600160a01b038116810361057e5790565b1561135f57565b60405162461bcd60e51b815260206004820152600b60248201526a5a65726f4164647265737360a81b6044820152606490fd5b80518210156112935760209160051b010190565b6001600160a01b03168015611404575f5160206119a35f395f51905f5280546001600160a01b0319811683179091556001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e05f80a3565b631e4fbdf760e01b5f525f60045260245ffd5b60ff5f5160206119c35f395f51905f52541661142f57565b63d93c066560e01b5f5260045ffd5b805180835260209291819084018484015e5f828201840152601f01601f1916010190565b90608061148d61147b845160a0855260a085019061143e565b6020850151848203602086015261143e565b926040810151604084015261ffff60608201511660608401520151906080818403910152602060c0608060a085019380511515865260ff84820151168487015260ff604082015116604087015260018060a01b03606082015116606087015201519360a060808201528451809452019201905f5b81811061150e5750505090565b82516001600160a01b0316845260209384019390920191600101611501565b600254915f926e5af43d82803e903d91602b57fd5bf3835160206115986017828801518360405194859281808501988051918291018a5e8401908282015f8152815193849201905e01013360601b8152620332e360ec1b601482015203600819810184520182611042565b51902091763d602d80600a3d3981f3363d3d373d3d3d363d7300000062ffffff8260881c16175f526effffffffffffffffffffffffffffff199060781b1617602052603760095ff5916001600160a01b03831680156118a257608082015160600151604083015185916001600160a01b031690341561183c575f546001600160a01b03169182149081611832575b501561182357803b1561057e575f60049160405192838092630d0e30db60e41b825234905af180156110085761180c575b50855461166e9134916001600160a01b03166118e4565b5f5160206119a35f395f51905f5254600154865487926001600160a01b039081169281169116843b1561034757604051630efbea2f60e21b815260a0600482015292849284928392916116c460a485018b611462565b92336024860152604485015260648401526084830152038183875af18015610cc5576117f7575b5050338552600360205260408520805490600160401b8210156117e357906117189160018201815561127e565b81546001600160a01b0360039290921b91821b19169083901b179055600454600160401b8110156117cf577f64ebc17e4f1cfa3b3dc33c6b6e50fd0cb0f9fe4fd739a3742ddfad53b50107c793949561177b82600160409401600455600461127e565b81549060031b9085821b9160018060a01b03901b1916179055828152600560205220600160ff198254161790556117ca6040519283923384526020840152606060408401526060830190611462565b0390a1565b634e487b7160e01b86526041600452602486fd5b634e487b7160e01b87526041600452602487fd5b8161180191611042565b61034357845f6116eb565b6118199196505f90611042565b5f9461166e611657565b6312b97cdb60e31b5f5260045ffd5b905034145f611626565b908161184b575b50505061166e565b6040516323b872dd60e01b60208201523360248201526001600160a01b039093166044840152606483019190915261189a919061189582608481015b03601f198101845283611042565b61191f565b5f8080611843565b63b06ebf3d60e01b5f5260045ffd5b5f5160206119a35f395f51905f52546001600160a01b031633036118d157565b63118cdaa760e01b5f523360045260245ffd5b60405163a9059cbb60e01b60208201526001600160a01b039092166024830152604482019290925261191d916118958260648101611887565b565b905f602091828151910182855af115611008575f513d61196e57506001600160a01b0381163b155b61194e5750565b635274afe760e01b5f9081526001600160a01b0391909116600452602490fd5b60011415611947565b60ff5f5160206119e35f395f51905f525460401c161561199357565b631afcd79f60e31b5f5260045ffdfe9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300cd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300f0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00a164736f6c634300081c000a
Verified Source Code Partial Match
Compiler: v0.8.28+commit.7893614a
EVM: cancun
Optimization: Yes (150 runs)
OwnableUpgradeable.sol 119 lines
// 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);
}
}
Initializable.sol 228 lines
// 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
}
}
}
ContextUpgradeable.sol 34 lines
// 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;
}
}
PausableUpgradeable.sol 140 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract PausableUpgradeable is Initializable, ContextUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Pausable
struct PausableStorage {
bool _paused;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Pausable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant PausableStorageLocation = 0xcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300;
function _getPausableStorage() private pure returns (PausableStorage storage $) {
assembly {
$.slot := PausableStorageLocation
}
}
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
/**
* @dev The operation failed because the contract is paused.
*/
error EnforcedPause();
/**
* @dev The operation failed because the contract is not paused.
*/
error ExpectedPause();
/**
* @dev Initializes the contract in unpaused state.
*/
function __Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __Pausable_init_unchained() internal onlyInitializing {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
PausableStorage storage $ = _getPausableStorage();
return $._paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
if (paused()) {
revert EnforcedPause();
}
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
if (!paused()) {
revert ExpectedPause();
}
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
emit Unpaused(_msgSender());
}
}
IERC1363.sol 86 lines
// 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);
}
IERC165.sol 6 lines
// 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";
IERC20.sol 6 lines
// 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";
Clones.sol 262 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (proxy/Clones.sol)
pragma solidity ^0.8.20;
import {Create2} from "../utils/Create2.sol";
import {Errors} from "../utils/Errors.sol";
/**
* @dev https://eips.ethereum.org/EIPS/eip-1167[ERC-1167] is a standard for
* deploying minimal proxy contracts, also known as "clones".
*
* > To simply and cheaply clone contract functionality in an immutable way, this standard specifies
* > a minimal bytecode implementation that delegates all calls to a known, fixed address.
*
* The library includes functions to deploy a proxy using either `create` (traditional deployment) or `create2`
* (salted deterministic deployment). It also includes functions to predict the addresses of clones deployed using the
* deterministic method.
*/
library Clones {
error CloneArgumentsTooLong();
/**
* @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation`.
*
* This function uses the create opcode, which should never revert.
*/
function clone(address implementation) internal returns (address instance) {
return clone(implementation, 0);
}
/**
* @dev Same as {xref-Clones-clone-address-}[clone], but with a `value` parameter to send native currency
* to the new contract.
*
* NOTE: Using a non-zero value at creation will require the contract using this function (e.g. a factory)
* to always have enough balance for new deployments. Consider exposing this function under a payable method.
*/
function clone(address implementation, uint256 value) internal returns (address instance) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
assembly ("memory-safe") {
// Cleans the upper 96 bits of the `implementation` word, then packs the first 3 bytes
// of the `implementation` address with the bytecode before the address.
mstore(0x00, or(shr(0xe8, shl(0x60, implementation)), 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000))
// Packs the remaining 17 bytes of `implementation` with the bytecode after the address.
mstore(0x20, or(shl(0x78, implementation), 0x5af43d82803e903d91602b57fd5bf3))
instance := create(value, 0x09, 0x37)
}
if (instance == address(0)) {
revert Errors.FailedDeployment();
}
}
/**
* @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation`.
*
* This function uses the create2 opcode and a `salt` to deterministically deploy
* the clone. Using the same `implementation` and `salt` multiple times will revert, since
* the clones cannot be deployed twice at the same address.
*/
function cloneDeterministic(address implementation, bytes32 salt) internal returns (address instance) {
return cloneDeterministic(implementation, salt, 0);
}
/**
* @dev Same as {xref-Clones-cloneDeterministic-address-bytes32-}[cloneDeterministic], but with
* a `value` parameter to send native currency to the new contract.
*
* NOTE: Using a non-zero value at creation will require the contract using this function (e.g. a factory)
* to always have enough balance for new deployments. Consider exposing this function under a payable method.
*/
function cloneDeterministic(
address implementation,
bytes32 salt,
uint256 value
) internal returns (address instance) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
assembly ("memory-safe") {
// Cleans the upper 96 bits of the `implementation` word, then packs the first 3 bytes
// of the `implementation` address with the bytecode before the address.
mstore(0x00, or(shr(0xe8, shl(0x60, implementation)), 0x3d602d80600a3d3981f3363d3d373d3d3d363d73000000))
// Packs the remaining 17 bytes of `implementation` with the bytecode after the address.
mstore(0x20, or(shl(0x78, implementation), 0x5af43d82803e903d91602b57fd5bf3))
instance := create2(value, 0x09, 0x37, salt)
}
if (instance == address(0)) {
revert Errors.FailedDeployment();
}
}
/**
* @dev Computes the address of a clone deployed using {Clones-cloneDeterministic}.
*/
function predictDeterministicAddress(
address implementation,
bytes32 salt,
address deployer
) internal pure returns (address predicted) {
assembly ("memory-safe") {
let ptr := mload(0x40)
mstore(add(ptr, 0x38), deployer)
mstore(add(ptr, 0x24), 0x5af43d82803e903d91602b57fd5bf3ff)
mstore(add(ptr, 0x14), implementation)
mstore(ptr, 0x3d602d80600a3d3981f3363d3d373d3d3d363d73)
mstore(add(ptr, 0x58), salt)
mstore(add(ptr, 0x78), keccak256(add(ptr, 0x0c), 0x37))
predicted := and(keccak256(add(ptr, 0x43), 0x55), 0xffffffffffffffffffffffffffffffffffffffff)
}
}
/**
* @dev Computes the address of a clone deployed using {Clones-cloneDeterministic}.
*/
function predictDeterministicAddress(
address implementation,
bytes32 salt
) internal view returns (address predicted) {
return predictDeterministicAddress(implementation, salt, address(this));
}
/**
* @dev Deploys and returns the address of a clone that mimics the behavior of `implementation` with custom
* immutable arguments. These are provided through `args` and cannot be changed after deployment. To
* access the arguments within the implementation, use {fetchCloneArgs}.
*
* This function uses the create opcode, which should never revert.
*/
function cloneWithImmutableArgs(address implementation, bytes memory args) internal returns (address instance) {
return cloneWithImmutableArgs(implementation, args, 0);
}
/**
* @dev Same as {xref-Clones-cloneWithImmutableArgs-address-bytes-}[cloneWithImmutableArgs], but with a `value`
* parameter to send native currency to the new contract.
*
* NOTE: Using a non-zero value at creation will require the contract using this function (e.g. a factory)
* to always have enough balance for new deployments. Consider exposing this function under a payable method.
*/
function cloneWithImmutableArgs(
address implementation,
bytes memory args,
uint256 value
) internal returns (address instance) {
if (address(this).balance < value) {
revert Errors.InsufficientBalance(address(this).balance, value);
}
bytes memory bytecode = _cloneCodeWithImmutableArgs(implementation, args);
assembly ("memory-safe") {
instance := create(value, add(bytecode, 0x20), mload(bytecode))
}
if (instance == address(0)) {
revert Errors.FailedDeployment();
}
}
/**
* @dev Deploys and returns the address of a clone that mimics the behaviour of `implementation` with custom
* immutable arguments. These are provided through `args` and cannot be changed after deployment. To
* access the arguments within the implementation, use {fetchCloneArgs}.
*
* This function uses the create2 opcode and a `salt` to deterministically deploy the clone. Using the same
* `implementation`, `args` and `salt` multiple times will revert, since the clones cannot be deployed twice
* at the same address.
*/
function cloneDeterministicWithImmutableArgs(
address implementation,
bytes memory args,
bytes32 salt
) internal returns (address instance) {
return cloneDeterministicWithImmutableArgs(implementation, args, salt, 0);
}
/**
* @dev Same as {xref-Clones-cloneDeterministicWithImmutableArgs-address-bytes-bytes32-}[cloneDeterministicWithImmutableArgs],
* but with a `value` parameter to send native currency to the new contract.
*
* NOTE: Using a non-zero value at creation will require the contract using this function (e.g. a factory)
* to always have enough balance for new deployments. Consider exposing this function under a payable method.
*/
function cloneDeterministicWithImmutableArgs(
address implementation,
bytes memory args,
bytes32 salt,
uint256 value
) internal returns (address instance) {
bytes memory bytecode = _cloneCodeWithImmutableArgs(implementation, args);
return Create2.deploy(value, salt, bytecode);
}
/**
* @dev Computes the address of a clone deployed using {Clones-cloneDeterministicWithImmutableArgs}.
*/
function predictDeterministicAddressWithImmutableArgs(
address implementation,
bytes memory args,
bytes32 salt,
address deployer
) internal pure returns (address predicted) {
bytes memory bytecode = _cloneCodeWithImmutableArgs(implementation, args);
return Create2.computeAddress(salt, keccak256(bytecode), deployer);
}
/**
* @dev Computes the address of a clone deployed using {Clones-cloneDeterministicWithImmutableArgs}.
*/
function predictDeterministicAddressWithImmutableArgs(
address implementation,
bytes memory args,
bytes32 salt
) internal view returns (address predicted) {
return predictDeterministicAddressWithImmutableArgs(implementation, args, salt, address(this));
}
/**
* @dev Get the immutable args attached to a clone.
*
* - If `instance` is a clone that was deployed using `clone` or `cloneDeterministic`, this
* function will return an empty array.
* - If `instance` is a clone that was deployed using `cloneWithImmutableArgs` or
* `cloneDeterministicWithImmutableArgs`, this function will return the args array used at
* creation.
* - If `instance` is NOT a clone deployed using this library, the behavior is undefined. This
* function should only be used to check addresses that are known to be clones.
*/
function fetchCloneArgs(address instance) internal view returns (bytes memory) {
bytes memory result = new bytes(instance.code.length - 45); // revert if length is too short
assembly ("memory-safe") {
extcodecopy(instance, add(result, 32), 45, mload(result))
}
return result;
}
/**
* @dev Helper that prepares the initcode of the proxy with immutable args.
*
* An assembly variant of this function requires copying the `args` array, which can be efficiently done using
* `mcopy`. Unfortunately, that opcode is not available before cancun. A pure solidity implementation using
* abi.encodePacked is more expensive but also more portable and easier to review.
*
* NOTE: https://eips.ethereum.org/EIPS/eip-170[EIP-170] limits the length of the contract code to 24576 bytes.
* With the proxy code taking 45 bytes, that limits the length of the immutable args to 24531 bytes.
*/
function _cloneCodeWithImmutableArgs(
address implementation,
bytes memory args
) private pure returns (bytes memory) {
if (args.length > 24531) revert CloneArgumentsTooLong();
return
abi.encodePacked(
hex"61",
uint16(args.length + 45),
hex"3d81600a3d39f3363d3d373d3d3d363d73",
implementation,
hex"5af43d82803e903d91602b57fd5bf3",
args
);
}
}
IERC1155.sol 123 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC1155/IERC1155.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-1155 compliant contract, as defined in the
* https://eips.ethereum.org/EIPS/eip-1155[ERC].
*/
interface IERC1155 is IERC165 {
/**
* @dev Emitted when `value` amount of tokens of type `id` are transferred from `from` to `to` by `operator`.
*/
event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value);
/**
* @dev Equivalent to multiple {TransferSingle} events, where `operator`, `from` and `to` are the same for all
* transfers.
*/
event TransferBatch(
address indexed operator,
address indexed from,
address indexed to,
uint256[] ids,
uint256[] values
);
/**
* @dev Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to
* `approved`.
*/
event ApprovalForAll(address indexed account, address indexed operator, bool approved);
/**
* @dev Emitted when the URI for token type `id` changes to `value`, if it is a non-programmatic URI.
*
* If an {URI} event was emitted for `id`, the standard
* https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that `value` will equal the value
* returned by {IERC1155MetadataURI-uri}.
*/
event URI(string value, uint256 indexed id);
/**
* @dev Returns the value of tokens of token type `id` owned by `account`.
*/
function balanceOf(address account, uint256 id) external view returns (uint256);
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {balanceOf}.
*
* Requirements:
*
* - `accounts` and `ids` must have the same length.
*/
function balanceOfBatch(
address[] calldata accounts,
uint256[] calldata ids
) external view returns (uint256[] memory);
/**
* @dev Grants or revokes permission to `operator` to transfer the caller's tokens, according to `approved`,
*
* Emits an {ApprovalForAll} event.
*
* Requirements:
*
* - `operator` cannot be the zero address.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns true if `operator` is approved to transfer ``account``'s tokens.
*
* See {setApprovalForAll}.
*/
function isApprovedForAll(address account, address operator) external view returns (bool);
/**
* @dev Transfers a `value` amount of tokens of type `id` from `from` to `to`.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {onERC1155Received} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits a {TransferSingle} event.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - If the caller is not `from`, it must have been approved to spend ``from``'s tokens via {setApprovalForAll}.
* - `from` must have a balance of tokens of type `id` of at least `value` amount.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the
* acceptance magic value.
*/
function safeTransferFrom(address from, address to, uint256 id, uint256 value, bytes calldata data) external;
/**
* @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}.
*
* WARNING: This function can potentially allow a reentrancy attack when transferring tokens
* to an untrusted contract, when invoking {onERC1155BatchReceived} on the receiver.
* Ensure to follow the checks-effects-interactions pattern and consider employing
* reentrancy guards when interacting with untrusted contracts.
*
* Emits either a {TransferSingle} or a {TransferBatch} event, depending on the length of the array arguments.
*
* Requirements:
*
* - `ids` and `values` must have the same length.
* - If `to` refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the
* acceptance magic value.
*/
function safeBatchTransferFrom(
address from,
address to,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external;
}
IERC20.sol 79 lines
// 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);
}
SafeERC20.sol 198 lines
// 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);
}
}
IERC721.sol 135 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (token/ERC721/IERC721.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC-721 compliant contract.
*/
interface IERC721 is IERC165 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(address indexed owner, address indexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId, bytes calldata data) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC-721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or
* {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon
* a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC-721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 tokenId) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the address zero.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId) external view returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator) external view returns (bool);
}
Create2.sol 92 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Create2.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Helper to make usage of the `CREATE2` EVM opcode easier and safer.
* `CREATE2` can be used to compute in advance the address where a smart
* contract will be deployed, which allows for interesting new mechanisms known
* as 'counterfactual interactions'.
*
* See the https://eips.ethereum.org/EIPS/eip-1014#motivation[EIP] for more
* information.
*/
library Create2 {
/**
* @dev There's no code to deploy.
*/
error Create2EmptyBytecode();
/**
* @dev Deploys a contract using `CREATE2`. The address where the contract
* will be deployed can be known in advance via {computeAddress}.
*
* The bytecode for a contract can be obtained from Solidity with
* `type(contractName).creationCode`.
*
* Requirements:
*
* - `bytecode` must not be empty.
* - `salt` must have not been used for `bytecode` already.
* - the factory must have a balance of at least `amount`.
* - if `amount` is non-zero, `bytecode` must have a `payable` constructor.
*/
function deploy(uint256 amount, bytes32 salt, bytes memory bytecode) internal returns (address addr) {
if (address(this).balance < amount) {
revert Errors.InsufficientBalance(address(this).balance, amount);
}
if (bytecode.length == 0) {
revert Create2EmptyBytecode();
}
assembly ("memory-safe") {
addr := create2(amount, add(bytecode, 0x20), mload(bytecode), salt)
// if no address was created, and returndata is not empty, bubble revert
if and(iszero(addr), not(iszero(returndatasize()))) {
let p := mload(0x40)
returndatacopy(p, 0, returndatasize())
revert(p, returndatasize())
}
}
if (addr == address(0)) {
revert Errors.FailedDeployment();
}
}
/**
* @dev Returns the address where a contract will be stored if deployed via {deploy}. Any change in the
* `bytecodeHash` or `salt` will result in a new destination address.
*/
function computeAddress(bytes32 salt, bytes32 bytecodeHash) internal view returns (address) {
return computeAddress(salt, bytecodeHash, address(this));
}
/**
* @dev Returns the address where a contract will be stored if deployed via {deploy} from a contract located at
* `deployer`. If `deployer` is this contract's address, returns the same value as {computeAddress}.
*/
function computeAddress(bytes32 salt, bytes32 bytecodeHash, address deployer) internal pure returns (address addr) {
assembly ("memory-safe") {
let ptr := mload(0x40) // Get free memory pointer
// | | ↓ ptr ... ↓ ptr + 0x0B (start) ... ↓ ptr + 0x20 ... ↓ ptr + 0x40 ... |
// |-------------------|---------------------------------------------------------------------------|
// | bytecodeHash | CCCCCCCCCCCCC...CC |
// | salt | BBBBBBBBBBBBB...BB |
// | deployer | 000000...0000AAAAAAAAAAAAAAAAAAA...AA |
// | 0xFF | FF |
// |-------------------|---------------------------------------------------------------------------|
// | memory | 000000...00FFAAAAAAAAAAAAAAAAAAA...AABBBBBBBBBBBBB...BBCCCCCCCCCCCCC...CC |
// | keccak(start, 85) | ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑ |
mstore(add(ptr, 0x40), bytecodeHash)
mstore(add(ptr, 0x20), salt)
mstore(ptr, deployer) // Right-aligned with 12 preceding garbage bytes
let start := add(ptr, 0x0b) // The hashed data starts at the final garbage byte which we will set to 0xff
mstore8(start, 0xff)
addr := and(keccak256(start, 85), 0xffffffffffffffffffffffffffffffffffffffff)
}
}
}
Errors.sol 34 lines
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}
IERC165.sol 25 lines
// 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);
}
Withdrawable.sol 100 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
/**
* @title Withdrawable
* @notice Abstract contract providing sweep functions for native tokens, ERC20, ERC721, and ERC1155 tokens
* @dev Child contracts must implement the `_checkWithdrawPermission` modifier to enforce access control
*/
abstract contract Withdrawable {
using SafeERC20 for IERC20;
error ArrayLengthMismatch();
/// @dev Modifier to check if the caller has permission to withdraw
/// @dev Must be implemented by the child contract
modifier onlyWithdrawer() {
_checkWithdrawPermission();
_;
}
/// @notice Check if the caller has permission to withdraw
/// @dev Must be implemented by the child contract
function _checkWithdrawPermission() internal view virtual;
/// @notice Sweep native token to the caller
/// @param amount Amount of native token to sweep
function sweepNativeToken(uint256 amount) external onlyWithdrawer {
uint256 balance = address(this).balance;
if (amount > balance) amount = balance;
(bool success, ) = msg.sender.call{ value: amount }("");
require(success, "Failed to send native token");
}
/// @notice Sweeps ERC20 tokens to the caller
/// @param tokens Tokens to sweep
/// @param amounts Amounts of tokens to sweep
function sweepERC20(address[] calldata tokens, uint256[] memory amounts) external onlyWithdrawer {
if (tokens.length != amounts.length) revert ArrayLengthMismatch();
for (uint256 i; i < tokens.length; ) {
require(tokens[i] != address(0), "ZeroAddress");
IERC20 token = IERC20(tokens[i]);
uint256 balance = token.balanceOf(address(this));
if (amounts[i] > balance) amounts[i] = balance;
token.safeTransfer(msg.sender, amounts[i]);
unchecked {
i++;
}
}
}
/// @notice Sweeps ERC721 tokens to the caller
/// @param tokens Tokens to sweep
/// @param tokenIds Token IDs to sweep
function sweepERC721(address[] calldata tokens, uint256[] calldata tokenIds) external onlyWithdrawer {
if (tokens.length != tokenIds.length) revert ArrayLengthMismatch();
for (uint256 i; i < tokens.length; ) {
require(tokens[i] != address(0), "ZeroAddress");
IERC721 token = IERC721(tokens[i]);
token.safeTransferFrom(address(this), msg.sender, tokenIds[i]);
unchecked {
i++;
}
}
}
/// @notice Sweeps ERC1155 tokens to the caller
/// @param tokens Tokens to sweep
/// @param tokenIds Token IDs to sweep
/// @param amounts Amounts of tokens to sweep
function sweepERC1155(
address[] calldata tokens,
uint256[] calldata tokenIds,
uint256[] memory amounts
) external onlyWithdrawer {
if (tokens.length != tokenIds.length) revert ArrayLengthMismatch();
if (tokens.length != amounts.length) revert ArrayLengthMismatch();
for (uint256 i; i < tokens.length; ) {
require(tokens[i] != address(0), "ZeroAddress");
IERC1155 token = IERC1155(tokens[i]);
uint256 balance = token.balanceOf(address(this), tokenIds[i]);
if (amounts[i] > balance) amounts[i] = balance;
token.safeTransferFrom(address(this), msg.sender, tokenIds[i], amounts[i], "");
unchecked {
i++;
}
}
}
}
VaultFactory.sol 139 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import "@openzeppelin/contracts-upgradeable/utils/PausableUpgradeable.sol";
import "@openzeppelin/contracts/proxy/Clones.sol";
import "../interfaces/core/IVaultFactory.sol";
import "../interfaces/core/IVault.sol";
import "../interfaces/IWETH9.sol";
import "../../common/Withdrawable.sol";
/// @title VaultFactory
contract VaultFactory is OwnableUpgradeable, PausableUpgradeable, Withdrawable, IVaultFactory {
using SafeERC20 for IERC20;
address public override WETH;
address public configManager;
address public vaultImplementation;
mapping(address => address[]) public vaultsByAddress;
address[] public allVaults;
mapping(address => bool) public isVaultAddress;
function initialize(
address _owner,
address _weth,
address _configManager,
address _vaultImplementation
) external initializer {
require(
_owner != address(0) && _weth != address(0) && _configManager != address(0) && _vaultImplementation != address(0),
ZeroAddress()
);
__Ownable_init(_owner);
__Pausable_init();
WETH = _weth;
configManager = _configManager;
vaultImplementation = _vaultImplementation;
}
/// @notice Create a new vault
/// @param params Vault creation parameters
/// @return vault Address of the new vault
function createVault(
VaultCreateParams memory params
) external payable override whenNotPaused returns (address vault) {
vault = _createVault(params);
IVault(vault).transferOwnership(_msgSender());
}
/// @notice Create a new vault and allocate
/// @param params Vault creation parameters
/// @param inputAssets Assets to allocate
/// @param strategy Strategy to use for allocation
/// @param data Additional data for allocation
/// @return vault Address of the new vault
function createVaultAndAllocate(
VaultCreateParams memory params,
AssetLib.Asset[] calldata inputAssets,
IStrategy strategy,
bytes calldata data
) external payable override whenNotPaused returns (address vault) {
vault = _createVault(params);
IVault(vault).allocate(inputAssets, strategy, 0, data);
IVault(vault).transferOwnership(_msgSender());
}
function _createVault(VaultCreateParams memory params) internal returns (address vault) {
vault = Clones.cloneDeterministic(
vaultImplementation,
keccak256(abi.encodePacked(params.name, params.symbol, _msgSender(), "3.0"))
);
address sender = _msgSender();
address principalToken = params.config.principalToken;
uint256 principalAmount = params.principalTokenAmount;
if (msg.value > 0) {
require(principalToken == WETH && principalAmount == msg.value, InvalidPrincipalToken());
IWETH9(WETH).deposit{ value: msg.value }();
IERC20(WETH).safeTransfer(vault, msg.value);
} else if (principalAmount > 0) {
IERC20(principalToken).safeTransferFrom(sender, vault, principalAmount);
}
IVault(vault).initialize(params, sender, owner(), configManager, WETH);
vaultsByAddress[sender].push(vault);
allVaults.push(vault);
isVaultAddress[vault] = true;
emit VaultCreated(sender, vault, params);
}
/// @notice Pause the contract
function pause() external onlyOwner {
_pause();
}
/// @notice Unpause the contract
function unpause() external onlyOwner {
_unpause();
}
/// @notice Set the ConfigManager address
/// @param _configManager Address of the new ConfigManager
function setConfigManager(address _configManager) external onlyOwner {
require(_configManager != address(0), ZeroAddress());
configManager = _configManager;
emit ConfigManagerSet(_configManager);
}
/// @notice Set the Vault implementation
/// @param _vaultImplementation Address of the new vault implementation
function setVaultImplementation(address _vaultImplementation) external onlyOwner {
require(_vaultImplementation != address(0), ZeroAddress());
vaultImplementation = _vaultImplementation;
emit VaultImplementationSet(_vaultImplementation);
}
/// @notice Check if a vault created by this factory
/// @param vault Address of the vault to check
function isVault(address vault) external view override returns (bool) {
return isVaultAddress[vault];
}
/// @inheritdoc Withdrawable
function _checkWithdrawPermission() internal view override {
_checkOwner();
}
}
IVault.sol 110 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.28;
import "../ICommon.sol";
import "../strategies/IStrategy.sol";
interface IVault is ICommon {
event VaultDeposit(address indexed vaultFactory, address indexed account, uint256 principalAmount, uint256 shares);
event VaultWithdraw(address indexed vaultFactory, address indexed account, uint256 principalAmount, uint256 shares);
event VaultAllocate(
address indexed vaultFactory, AssetLib.Asset[] inputAssets, IStrategy strategy, AssetLib.Asset[] newAssets
);
event VaultHarvest(address indexed vaultFactory, AssetLib.Asset[] harvestedAssets);
event VaultHarvestPrivate(address indexed vaultFactory, address indexed owner, uint256 principalHarvestedAmount);
event SetVaultConfig(address indexed vaultFactory, VaultConfig config, uint16 vaultOwnerFeeBasisPoint);
event VaultOwnerChanged(address indexed vaultFactory, address indexed oldOwner, address indexed newOwner);
event SetVaultAdmin(address indexed vaultFactory, address indexed _address, bool indexed _isAdmin);
error VaultPaused();
error InvalidAssetToken();
error InvalidAssetAmount();
error InvalidSweepAsset();
error InvalidAssetStrategy();
error DepositAllowed();
error DepositNotAllowed();
error MaxPositionsReached();
error InvalidShares();
error Unauthorized();
error InsufficientShares();
error FailedToSendEther();
error InvalidWETH();
error InsufficientReturnAmount();
error ExceedMaxAllocatePerBlock();
error StrategyDelegateCallFailed();
function vaultOwner() external view returns (address);
function WETH() external view returns (address);
function initialize(
VaultCreateParams calldata params,
address _owner,
address _operator,
address _configManager,
address _weth
) external;
function deposit(uint256 principalAmount, uint256 minShares) external payable returns (uint256 returnShares);
function depositPrincipal(uint256 principalAmount) external payable returns (uint256 shares);
function withdraw(uint256 shares, bool unwrap, uint256 minReturnAmount) external returns (uint256 returnAmount);
function withdrawPrincipal(uint256 amount, bool unwrap) external returns (uint256 returnAmount);
function allocate(
AssetLib.Asset[] calldata inputAssets,
IStrategy strategy,
uint64 gasFeeBasisPoint,
bytes calldata data
) external;
function harvest(AssetLib.Asset calldata asset, uint64 gasFeeBasisPoint, uint256 amountTokenOutMin)
external
returns (AssetLib.Asset[] memory harvestedAssets);
function harvestPrivate(
AssetLib.Asset[] calldata asset,
bool unwrap,
uint64 gasFeeBasisPoint,
uint256 amountTokenOutMin
) external;
function getTotalValue() external view returns (uint256);
function grantAdminRole(address _address) external;
function revokeAdminRole(address _address) external;
function sweepToken(address[] calldata tokens) external;
function sweepERC721(address[] calldata _tokens, uint256[] calldata _tokenIds) external;
function sweepERC1155(address[] calldata _tokens, uint256[] calldata _tokenIds) external;
function allowDeposit(VaultConfig calldata _config, uint16 _vaultOwnerFeeBasisPoint) external;
function transferOwnership(address _newOwner) external;
function getInventory() external view returns (AssetLib.Asset[] memory assets);
function getVaultConfig()
external
view
returns (
bool allowDeposit,
uint8 rangeStrategyType,
uint8 tvlStrategyType,
address principalToken,
address[] memory supportedAddresses,
uint16 vaultOwnerFeeBasisPoint
);
}
IVaultFactory.sol 32 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.28;
import "../strategies/IStrategy.sol";
import "../ICommon.sol";
interface IVaultFactory is ICommon {
event VaultCreated(address owner, address vault, VaultCreateParams params);
event ConfigManagerSet(address configManager);
event VaultImplementationSet(address vaultImplementation);
error InvalidPrincipalToken();
function createVault(VaultCreateParams memory params) external payable returns (address vault);
function createVaultAndAllocate(
VaultCreateParams memory params,
AssetLib.Asset[] calldata inputAssets,
IStrategy strategy,
bytes calldata data
) external payable returns (address vault);
function setConfigManager(address _configManager) external;
function setVaultImplementation(address _vaultImplementation) external;
function WETH() external view returns (address);
function isVault(address vault) external view returns (bool);
}
ICommon.sol 58 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.28;
interface ICommon {
struct VaultConfig {
bool allowDeposit;
uint8 rangeStrategyType;
uint8 tvlStrategyType;
address principalToken;
address[] supportedAddresses;
}
struct VaultCreateParams {
string name;
string symbol;
uint256 principalTokenAmount;
uint16 vaultOwnerFeeBasisPoint;
VaultConfig config;
}
struct FeeConfig {
uint16 vaultOwnerFeeBasisPoint;
address vaultOwner;
uint16 platformFeeBasisPoint;
address platformFeeRecipient;
uint64 gasFeeX64;
address gasFeeRecipient;
}
struct Instruction {
uint8 instructionType;
bytes params;
}
error ZeroAddress();
error TransferFailed();
error ExternalCallFailed();
error InvalidVaultConfig();
error InvalidFeeConfig();
error InvalidStrategy();
error InvalidSwapRouter();
error InvalidInstructionType();
error InvalidSigner();
error SignatureExpired();
error ApproveFailed();
error InvalidParams();
}
IWETH9.sol 13 lines
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.28;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
/// @title Interface for WETH9
interface IWETH9 is IERC20 {
/// @notice Deposit ether to get wrapped ether
function deposit() external payable;
/// @notice Withdraw wrapped ether to get ether
function withdraw(uint256) external;
}
IFeeTaker.sol 14 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.28;
interface IFeeTaker {
enum FeeType {
PLATFORM,
OWNER,
GAS
}
event FeeCollected(
address indexed vaultAddress, FeeType indexed feeType, address indexed recipient, address token, uint256 amount
);
}
IStrategy.sol 45 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.28;
import "../ICommon.sol";
import { AssetLib } from "../../libraries/AssetLib.sol";
import { IFeeTaker } from "./IFeeTaker.sol";
interface IStrategy is ICommon, IFeeTaker {
error InvalidAsset();
error InvalidNumberOfAssets();
error InsufficientAmountOut();
function valueOf(AssetLib.Asset calldata asset, address principalToken) external view returns (uint256);
function convert(
AssetLib.Asset[] calldata assets,
VaultConfig calldata config,
FeeConfig calldata feeConfig,
bytes calldata data
) external payable returns (AssetLib.Asset[] memory);
function harvest(
AssetLib.Asset calldata asset,
address tokenOut,
uint256 amountTokenOutMin,
VaultConfig calldata vaultConfig,
FeeConfig calldata feeConfig
) external payable returns (AssetLib.Asset[] memory);
function convertFromPrincipal(
AssetLib.Asset calldata existingAsset,
uint256 principalTokenAmount,
VaultConfig calldata config
) external payable returns (AssetLib.Asset[] memory);
function convertToPrincipal(
AssetLib.Asset memory existingAsset,
uint256 shares,
uint256 totalSupply,
VaultConfig calldata config,
FeeConfig calldata feeConfig
) external payable returns (AssetLib.Asset[] memory);
function revalidate(AssetLib.Asset calldata asset, VaultConfig calldata config) external;
}
AssetLib.sol 18 lines
// SPDX-License-Identifier: BUSL-1.1
pragma solidity >=0.8.28;
library AssetLib {
enum AssetType {
ERC20,
ERC721,
ERC1155
}
struct Asset {
AssetType assetType;
address strategy;
address token;
uint256 tokenId;
uint256 amount;
}
}
Read Contract
WETH 0xad5c4648 → address
allVaults 0x9094a91e → address
configManager 0xca0ab075 → address
isVault 0x652b9b41 → bool
isVaultAddress 0x184ffaa5 → bool
owner 0x8da5cb5b → address
paused 0x5c975abb → bool
vaultImplementation 0xbba48a90 → address
vaultsByAddress 0x40e274cc → address
Write Contract 13 functions
These functions modify contract state and require a wallet transaction to execute.
createVault 0xacf42833
tuple params
returns: address
createVaultAndAllocate 0x3891c5fd
tuple params
tuple[] inputAssets
address strategy
bytes data
returns: address
initialize 0xf8c8765e
address _owner
address _weth
address _configManager
address _vaultImplementation
pause 0x8456cb59
No parameters
renounceOwnership 0x715018a6
No parameters
setConfigManager 0xb4e25e80
address _configManager
setVaultImplementation 0x53e78b6b
address _vaultImplementation
sweepERC1155 0xcfd3c73d
address[] tokens
uint256[] tokenIds
uint256[] amounts
sweepERC20 0x9225a111
address[] tokens
uint256[] amounts
sweepERC721 0xc9c14d75
address[] tokens
uint256[] tokenIds
sweepNativeToken 0xba2b9b16
uint256 amount
transferOwnership 0xf2fde38b
address newOwner
unpause 0x3f4ba83a
No parameters
Recent Transactions
No transactions found for this address