Feature Tip: Add private address tag to any address under My Name Tag !
Overview
ETH Balance
0 ETH
Eth Value
$0.00More Info
Private Name Tags
ContractCreator
Latest 1 from a total of 1 transactions
Transaction Hash |
Method
|
Block
|
From
|
To
|
|||||
---|---|---|---|---|---|---|---|---|---|
0x61012060 | 17975183 | 411 days ago | IN | 0 ETH | 0.03098643 |
View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Loading...
Loading
Contract Name:
TimeLock
Compiler Version
v0.8.17+commit.8df45f5f
Optimization Enabled:
Yes with 200 runs
Other Settings:
london EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import {IERC20} from "../dependencies/openzeppelin/contracts/IERC20.sol"; import {IERC721} from "../dependencies/openzeppelin/contracts/IERC721.sol"; import {IERC1155} from "../dependencies/openzeppelin/contracts/IERC1155.sol"; import {IERC721Receiver} from "../dependencies/openzeppelin/contracts/IERC721Receiver.sol"; import "../dependencies/openzeppelin/upgradeability/ReentrancyGuardUpgradeable.sol"; import {ReentrancyGuardUpgradeable} from "../dependencies/openzeppelin/upgradeability/ReentrancyGuardUpgradeable.sol"; import {EnumerableSet} from "../dependencies/openzeppelin/contracts/EnumerableSet.sol"; import {ITimeLock} from "../interfaces/ITimeLock.sol"; import {IMoonBird} from "../dependencies/erc721-collections/IMoonBird.sol"; import {IPoolAddressesProvider} from "../interfaces/IPoolAddressesProvider.sol"; import {IPool} from "../interfaces/IPool.sol"; import {DataTypes} from "../protocol/libraries/types/DataTypes.sol"; import {GPv2SafeERC20} from "../dependencies/gnosis/contracts/GPv2SafeERC20.sol"; import {Errors} from "./../protocol/libraries/helpers/Errors.sol"; import {IACLManager} from "../interfaces/IACLManager.sol"; import {IWETH} from "./interfaces/IWETH.sol"; import {IWrappedPunks} from "./interfaces/IWrappedPunks.sol"; import {IPunks} from "./interfaces/IPunks.sol"; import {Helpers} from "../protocol/libraries/helpers/Helpers.sol"; contract TimeLock is ITimeLock, ReentrancyGuardUpgradeable, IERC721Receiver { using GPv2SafeERC20 for IERC20; mapping(uint256 => Agreement) private agreements; uint248 public agreementCount; bool public frozen; IPool private immutable POOL; IACLManager private immutable ACL_MANAGER; address private immutable weth; address private immutable wpunk; address private immutable Punk; modifier onlyXToken(address asset) { require( msg.sender == POOL.getReserveXToken(asset), Errors.CALLER_NOT_XTOKEN ); _; } modifier onlyEmergencyAdminOrPoolAdmins() { require( ACL_MANAGER.isEmergencyAdmin(msg.sender) || ACL_MANAGER.isPoolAdmin(msg.sender), Errors.CALLER_NOT_POOL_OR_EMERGENCY_ADMIN ); _; } modifier onlyPoolAdmin() { require( ACL_MANAGER.isPoolAdmin(msg.sender), Errors.CALLER_NOT_POOL_ADMIN ); _; } constructor(IPoolAddressesProvider provider, address _wpunk) { POOL = IPool(provider.getPool()); ACL_MANAGER = IACLManager(provider.getACLManager()); wpunk = _wpunk; Punk = _wpunk != address(0) ? IWrappedPunks(_wpunk).punkContract() : address(0); weth = provider.getWETH(); } function initialize() public initializer { __ReentrancyGuard_init(); } function createAgreement( DataTypes.AssetType assetType, DataTypes.TimeLockActionType actionType, address asset, uint256[] calldata tokenIdsOrAmounts, address beneficiary, uint48 releaseTime ) external onlyXToken(asset) returns (uint256) { require(beneficiary != address(0), "Beneficiary cant be zero address"); require(releaseTime > block.timestamp, "Release time not valid"); uint256 agreementId = agreementCount++; agreements[agreementId] = Agreement({ assetType: assetType, actionType: actionType, asset: asset, tokenIdsOrAmounts: tokenIdsOrAmounts, beneficiary: beneficiary, releaseTime: releaseTime, isFrozen: false }); emit AgreementCreated( agreementId, assetType, actionType, asset, tokenIdsOrAmounts, beneficiary, releaseTime ); return agreementId; } function _validateAndDeleteAgreement(uint256 agreementId) internal returns (Agreement memory) { Agreement memory agreement = agreements[agreementId]; require(msg.sender == agreement.beneficiary, "Not beneficiary"); require( block.timestamp >= agreement.releaseTime, "Release time not reached" ); require(!agreement.isFrozen, "Agreement frozen"); delete agreements[agreementId]; emit AgreementClaimed( agreementId, agreement.assetType, agreement.actionType, agreement.asset, agreement.tokenIdsOrAmounts, agreement.beneficiary ); return agreement; } function claim(uint256[] calldata agreementIds) external nonReentrant { require(!frozen, "TimeLock is frozen"); for (uint256 index = 0; index < agreementIds.length; index++) { Agreement memory agreement = _validateAndDeleteAgreement( agreementIds[index] ); if (agreement.assetType == DataTypes.AssetType.ERC20) { IERC20(agreement.asset).safeTransfer( agreement.beneficiary, agreement.tokenIdsOrAmounts[0] ); } else if (agreement.assetType == DataTypes.AssetType.ERC721) { IERC721 erc721 = IERC721(agreement.asset); for ( uint256 i = 0; i < agreement.tokenIdsOrAmounts.length; i++ ) { erc721.safeTransferFrom( address(this), agreement.beneficiary, agreement.tokenIdsOrAmounts[i] ); } } } } function claimMoonBirds(uint256[] calldata agreementIds) external nonReentrant { require(!frozen, "TimeLock is frozen"); for (uint256 index = 0; index < agreementIds.length; index++) { Agreement memory agreement = _validateAndDeleteAgreement( agreementIds[index] ); require( agreement.assetType == DataTypes.AssetType.ERC721, "Wrong asset type" ); IMoonBird moonBirds = IMoonBird(agreement.asset); for (uint256 i = 0; i < agreement.tokenIdsOrAmounts.length; i++) { moonBirds.safeTransferWhileNesting( address(this), agreement.beneficiary, agreement.tokenIdsOrAmounts[i] ); } } } function claimETH(uint256[] calldata agreementIds) external nonReentrant { require(!frozen, "TimeLock is frozen"); uint256 totalAmount = 0; for (uint256 index = 0; index < agreementIds.length; index++) { Agreement memory agreement = _validateAndDeleteAgreement( agreementIds[index] ); require(agreement.asset == weth, "Wrong agreement asset"); totalAmount += agreement.tokenIdsOrAmounts[0]; } IWETH(weth).withdraw(totalAmount); Helpers.safeTransferETH(msg.sender, totalAmount); } function claimPunk(uint256[] calldata agreementIds) external nonReentrant { require(!frozen, "TimeLock is frozen"); require(wpunk != address(0), "zero address"); IWrappedPunks WPunk = IWrappedPunks(wpunk); for (uint256 index = 0; index < agreementIds.length; index++) { Agreement memory agreement = _validateAndDeleteAgreement( agreementIds[index] ); require(agreement.asset == wpunk, "Wrong agreement asset"); uint256 tokenIdLength = agreement.tokenIdsOrAmounts.length; for (uint256 i = 0; i < tokenIdLength; i++) { uint256 tokenId = agreement.tokenIdsOrAmounts[i]; WPunk.burn(tokenId); IPunks(Punk).transferPunk(agreement.beneficiary, tokenId); } } } receive() external payable {} function freezeAgreement(uint256 agreementId) external onlyEmergencyAdminOrPoolAdmins { agreements[agreementId].isFrozen = true; emit AgreementFrozen(agreementId, true); } function unfreezeAgreement(uint256 agreementId) external onlyPoolAdmin { agreements[agreementId].isFrozen = false; emit AgreementFrozen(agreementId, false); } function freezeAllAgreements() external onlyEmergencyAdminOrPoolAdmins { frozen = true; emit TimeLockFrozen(true); } function unfreezeAllAgreements() external onlyPoolAdmin { frozen = false; emit TimeLockFrozen(false); } function getAgreement(uint256 agreementId) external view returns (Agreement memory agreement) { agreement = agreements[agreementId]; } function onERC721Received( address, address, uint256, bytes memory ) external virtual override returns (bytes4) { return this.onERC721Received.selector; } }
// SPDX-License-Identifier: UNLICENSED pragma solidity ^0.8.0; /** @title MoonBirds contract interface */ interface IMoonBirdBase { function nestingOpen() external view returns(bool); function toggleNesting(uint256[] calldata tokenIds) external; function nestingPeriod(uint256 tokenId) external view returns ( bool nesting, uint256 current, uint256 total ); } interface IMoonBird is IMoonBirdBase { function safeTransferWhileNesting( address from, address to, uint256 tokenId ) external; }
// SPDX-License-Identifier: LGPL-3.0-or-later pragma solidity ^0.8.0; import {IERC20} from "../../openzeppelin/contracts/IERC20.sol"; /// @title Gnosis Protocol v2 Safe ERC20 Transfer Library /// @author Gnosis Developers /// @dev Gas-efficient version of Openzeppelin's SafeERC20 contract. library GPv2SafeERC20 { /// @dev Wrapper around a call to the ERC20 function `transfer` that reverts /// also when the token returns `false`. function safeTransfer( IERC20 token, address to, uint256 value ) internal { bytes4 selector_ = token.transfer.selector; // solhint-disable-next-line no-inline-assembly assembly { let freeMemoryPointer := mload(0x40) mstore(freeMemoryPointer, selector_) mstore( add(freeMemoryPointer, 4), and(to, 0xffffffffffffffffffffffffffffffffffffffff) ) mstore(add(freeMemoryPointer, 36), value) if iszero(call(gas(), token, 0, freeMemoryPointer, 68, 0, 0)) { returndatacopy(0, 0, returndatasize()) revert(0, returndatasize()) } } require(getLastTransferResult(token), "GPv2: failed transfer"); } /// @dev Wrapper around a call to the ERC20 function `transferFrom` that /// reverts also when the token returns `false`. function safeTransferFrom( IERC20 token, address from, address to, uint256 value ) internal { bytes4 selector_ = token.transferFrom.selector; // solhint-disable-next-line no-inline-assembly assembly { let freeMemoryPointer := mload(0x40) mstore(freeMemoryPointer, selector_) mstore( add(freeMemoryPointer, 4), and(from, 0xffffffffffffffffffffffffffffffffffffffff) ) mstore( add(freeMemoryPointer, 36), and(to, 0xffffffffffffffffffffffffffffffffffffffff) ) mstore(add(freeMemoryPointer, 68), value) if iszero(call(gas(), token, 0, freeMemoryPointer, 100, 0, 0)) { returndatacopy(0, 0, returndatasize()) revert(0, returndatasize()) } } require(getLastTransferResult(token), "GPv2: failed transferFrom"); } /// @dev Verifies that the last return was a successful `transfer*` call. /// This is done by checking that the return data is either empty, or /// is a valid ABI encoded boolean. function getLastTransferResult(IERC20 token) private view returns (bool success) { // NOTE: Inspecting previous return data requires assembly. Note that // we write the return data to memory 0 in the case where the return // data size is 32, this is OK since the first 64 bytes of memory are // reserved by Solidy as a scratch space that can be used within // assembly blocks. // <https://docs.soliditylang.org/en/v0.7.6/internals/layout_in_memory.html> // solhint-disable-next-line no-inline-assembly assembly { /// @dev Revert with an ABI encoded Solidity error with a message /// that fits into 32-bytes. /// /// An ABI encoded Solidity error has the following memory layout: /// /// ------------+---------------------------------- /// byte range | value /// ------------+---------------------------------- /// 0x00..0x04 | selector("Error(string)") /// 0x04..0x24 | string offset (always 0x20) /// 0x24..0x44 | string length /// 0x44..0x64 | string value, padded to 32-bytes function revertWithMessage(length, message) { mstore(0x00, "\x08\xc3\x79\xa0") mstore(0x04, 0x20) mstore(0x24, length) mstore(0x44, message) revert(0x00, 0x64) } switch returndatasize() // Non-standard ERC20 transfer without return. case 0 { // NOTE: When the return data size is 0, verify that there // is code at the address. This is done in order to maintain // compatibility with Solidity calling conventions. // <https://docs.soliditylang.org/en/v0.7.6/control-structures.html#external-function-calls> if iszero(extcodesize(token)) { revertWithMessage(20, "GPv2: not a contract") } success := 1 } // Standard ERC20 transfer returning boolean success value. case 32 { returndatacopy(0, 0, returndatasize()) // NOTE: For ABI encoding v1, any non-zero value is accepted // as `true` for a boolean. In order to stay compatible with // OpenZeppelin's `SafeERC20` library which is known to work // with the existing ERC20 implementation we care about, // make sure we return success for any non-zero return value // from the `transfer*` call. success := iszero(iszero(mload(0))) } default { revertWithMessage(31, "GPv2: malformed transfer result") } } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol) pragma solidity ^0.8.0; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== * * [IMPORTANT] * ==== * You shouldn't rely on `isContract` to protect against flash loan attacks! * * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract * constructor. * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize/address.code.length, which returns 0 // for contracts in construction, since the code is only stored at the end // of the constructor execution. return account.code.length > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); (bool success, ) = recipient.call{value: amount}(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCall(target, data, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value ) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value, string memory errorMessage ) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); require(isContract(target), "Address: call to non-contract"); (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall( address target, bytes memory data, string memory errorMessage ) internal view returns (bytes memory) { require(isContract(target), "Address: static call to non-contract"); (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { require(isContract(target), "Address: delegate call to non-contract"); (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResult(success, returndata, errorMessage); } /** * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the * revert reason using the provided one. * * _Available since v4.3._ */ function verifyCallResult( bool success, bytes memory returndata, string memory errorMessage ) internal pure returns (bytes memory) { if (success) { return returndata; } else { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly /// @solidity memory-safe-assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert(errorMessage); } } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /* * @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 GSN 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 payable) { return payable(msg.sender); } function _msgData() internal view virtual returns (bytes memory) { this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691 return msg.data; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./IERC165.sol"; /** * @dev Implementation of the {IERC165} interface. * * Contracts that want to implement ERC165 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); * } * ``` * * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation. */ abstract contract ERC165 is IERC165 { /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IERC165).interfaceId; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (token/ERC721/ERC721.sol) pragma solidity ^0.8.0; import "./IERC721.sol"; import "./IERC721Receiver.sol"; import "./IERC721Metadata.sol"; import "./Address.sol"; import "./Context.sol"; import "./Strings.sol"; import "./ERC165.sol"; /** * @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including * the Metadata extension, but not including the Enumerable extension, which is available separately as * {ERC721Enumerable}. */ contract ERC721 is Context, ERC165, IERC721, IERC721Metadata { using Address for address; using Strings for uint256; // Token name string private _name; // Token symbol string private _symbol; // Mapping from token ID to owner address mapping(uint256 => address) private _owners; // Mapping owner address to token count mapping(address => uint256) private _balances; // Mapping from token ID to approved address mapping(uint256 => address) private _tokenApprovals; // Mapping from owner to operator approvals mapping(address => mapping(address => bool)) private _operatorApprovals; /** * @dev Initializes the contract by setting a `name` and a `symbol` to the token collection. */ constructor(string memory name_, string memory symbol_) { _name = name_; _symbol = symbol_; } /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override(ERC165) returns (bool) { return interfaceId == type(IERC721).interfaceId || interfaceId == type(IERC721Metadata).interfaceId || super.supportsInterface(interfaceId); } /** * @dev See {IERC721-balanceOf}. */ function balanceOf(address owner) public view virtual override returns (uint256) { require( owner != address(0), "ERC721: address zero is not a valid owner" ); return _balances[owner]; } /** * @dev See {IERC721-ownerOf}. */ function ownerOf(uint256 tokenId) public view virtual override returns (address) { address owner = _owners[tokenId]; require( owner != address(0), "ERC721: owner query for nonexistent token" ); return owner; } /** * @dev See {IERC721Metadata-name}. */ function name() public view virtual override returns (string memory) { return _name; } /** * @dev See {IERC721Metadata-symbol}. */ function symbol() public view virtual override returns (string memory) { return _symbol; } /** * @dev See {IERC721Metadata-tokenURI}. */ function tokenURI(uint256 tokenId) public view virtual override returns (string memory) { require( _exists(tokenId), "ERC721Metadata: URI query for nonexistent token" ); string memory baseURI = _baseURI(); return bytes(baseURI).length > 0 ? string(abi.encodePacked(baseURI, tokenId.toString())) : ""; } /** * @dev Base URI for computing {tokenURI}. If set, the resulting URI for each * token will be the concatenation of the `baseURI` and the `tokenId`. Empty * by default, can be overridden in child contracts. */ function _baseURI() internal view virtual returns (string memory) { return ""; } /** * @dev See {IERC721-approve}. */ function approve(address to, uint256 tokenId) public virtual override { address owner = ERC721.ownerOf(tokenId); require(to != owner, "ERC721: approval to current owner"); require( _msgSender() == owner || isApprovedForAll(owner, _msgSender()), "ERC721: approve caller is not owner nor approved for all" ); _approve(to, tokenId); } /** * @dev See {IERC721-getApproved}. */ function getApproved(uint256 tokenId) public view virtual override returns (address) { require( _exists(tokenId), "ERC721: approved query for nonexistent token" ); return _tokenApprovals[tokenId]; } /** * @dev See {IERC721-setApprovalForAll}. */ function setApprovalForAll(address operator, bool approved) public virtual override { _setApprovalForAll(_msgSender(), operator, approved); } /** * @dev See {IERC721-isApprovedForAll}. */ function isApprovedForAll(address owner, address operator) public view virtual override returns (bool) { return _operatorApprovals[owner][operator]; } /** * @dev See {IERC721-transferFrom}. */ function transferFrom( address from, address to, uint256 tokenId ) public virtual override { //solhint-disable-next-line max-line-length require( _isApprovedOrOwner(_msgSender(), tokenId), "ERC721: transfer caller is not owner nor approved" ); _transfer(from, to, tokenId); } /** * @dev See {IERC721-safeTransferFrom}. */ function safeTransferFrom( address from, address to, uint256 tokenId ) public virtual override { safeTransferFrom(from, to, tokenId, ""); } /** * @dev See {IERC721-safeTransferFrom}. */ function safeTransferFrom( address from, address to, uint256 tokenId, bytes memory _data ) public virtual override { require( _isApprovedOrOwner(_msgSender(), tokenId), "ERC721: transfer caller is not owner nor approved" ); _safeTransfer(from, to, tokenId, _data); } /** * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients * are aware of the ERC721 protocol to prevent tokens from being forever locked. * * `_data` is additional data, it has no specified format and it is sent in call to `to`. * * This internal function is equivalent to {safeTransferFrom}, and can be used to e.g. * implement alternative mechanisms to perform token transfer, such as signature-based. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function _safeTransfer( address from, address to, uint256 tokenId, bytes memory _data ) internal virtual { _transfer(from, to, tokenId); require( _checkOnERC721Received(from, to, tokenId, _data), "ERC721: transfer to non ERC721Receiver implementer" ); } /** * @dev Returns whether `tokenId` exists. * * Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}. * * Tokens start existing when they are minted (`_mint`), * and stop existing when they are burned (`_burn`). */ function _exists(uint256 tokenId) internal view virtual returns (bool) { return _owners[tokenId] != address(0); } /** * @dev Returns whether `spender` is allowed to manage `tokenId`. * * Requirements: * * - `tokenId` must exist. */ function _isApprovedOrOwner(address spender, uint256 tokenId) internal view virtual returns (bool) { require( _exists(tokenId), "ERC721: operator query for nonexistent token" ); address owner = ERC721.ownerOf(tokenId); return (spender == owner || isApprovedForAll(owner, spender) || getApproved(tokenId) == spender); } /** * @dev Safely mints `tokenId` and transfers it to `to`. * * Requirements: * * - `tokenId` must not exist. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function _safeMint(address to, uint256 tokenId) internal virtual { _safeMint(to, tokenId, ""); } /** * @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is * forwarded in {IERC721Receiver-onERC721Received} to contract recipients. */ function _safeMint( address to, uint256 tokenId, bytes memory _data ) internal virtual { _mint(to, tokenId); require( _checkOnERC721Received(address(0), to, tokenId, _data), "ERC721: transfer to non ERC721Receiver implementer" ); } /** * @dev Mints `tokenId` and transfers it to `to`. * * WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible * * Requirements: * * - `tokenId` must not exist. * - `to` cannot be the zero address. * * Emits a {Transfer} event. */ function _mint(address to, uint256 tokenId) internal virtual { require(to != address(0), "ERC721: mint to the zero address"); require(!_exists(tokenId), "ERC721: token already minted"); _beforeTokenTransfer(address(0), to, tokenId); _balances[to] += 1; _owners[tokenId] = to; emit Transfer(address(0), to, tokenId); _afterTokenTransfer(address(0), to, tokenId); } /** * @dev Destroys `tokenId`. * The approval is cleared when the token is burned. * * Requirements: * * - `tokenId` must exist. * * Emits a {Transfer} event. */ function _burn(uint256 tokenId) internal virtual { address owner = ERC721.ownerOf(tokenId); _beforeTokenTransfer(owner, address(0), tokenId); // Clear approvals _approve(address(0), tokenId); _balances[owner] -= 1; delete _owners[tokenId]; emit Transfer(owner, address(0), tokenId); _afterTokenTransfer(owner, address(0), tokenId); } /** * @dev Transfers `tokenId` from `from` to `to`. * As opposed to {transferFrom}, this imposes no restrictions on msg.sender. * * Requirements: * * - `to` cannot be the zero address. * - `tokenId` token must be owned by `from`. * * Emits a {Transfer} event. */ function _transfer( address from, address to, uint256 tokenId ) internal virtual { require( ERC721.ownerOf(tokenId) == from, "ERC721: transfer from incorrect owner" ); require(to != address(0), "ERC721: transfer to the zero address"); _beforeTokenTransfer(from, to, tokenId); // Clear approvals from the previous owner _approve(address(0), tokenId); _balances[from] -= 1; _balances[to] += 1; _owners[tokenId] = to; emit Transfer(from, to, tokenId); _afterTokenTransfer(from, to, tokenId); } /** * @dev Approve `to` to operate on `tokenId` * * Emits a {Approval} event. */ function _approve(address to, uint256 tokenId) internal virtual { _tokenApprovals[tokenId] = to; emit Approval(ERC721.ownerOf(tokenId), to, tokenId); } /** * @dev Approve `operator` to operate on all of `owner` tokens * * Emits a {ApprovalForAll} event. */ function _setApprovalForAll( address owner, address operator, bool approved ) internal virtual { require(owner != operator, "ERC721: approve to caller"); _operatorApprovals[owner][operator] = approved; emit ApprovalForAll(owner, operator, approved); } /** * @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address. * The call is not executed if the target address is not a contract. * * @param from address representing the previous owner of the given token ID * @param to target address that will receive the tokens * @param tokenId uint256 ID of the token to be transferred * @param _data bytes optional data to send along with the call * @return bool whether the call correctly returned the expected magic value */ function _checkOnERC721Received( address from, address to, uint256 tokenId, bytes memory _data ) private returns (bool) { if (to.isContract()) { try IERC721Receiver(to).onERC721Received( _msgSender(), from, tokenId, _data ) returns (bytes4 retval) { return retval == IERC721Receiver.onERC721Received.selector; } catch (bytes memory reason) { if (reason.length == 0) { revert( "ERC721: transfer to non ERC721Receiver implementer" ); } else { assembly { revert(add(32, reason), mload(reason)) } } } } else { return true; } } /** * @dev Hook that is called before any token transfer. This includes minting * and burning. * * Calling conditions: * * - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be * transferred to `to`. * - When `from` is zero, `tokenId` will be minted for `to`. * - When `to` is zero, ``from``'s `tokenId` will be burned. * - `from` and `to` are never both zero. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _beforeTokenTransfer( address from, address to, uint256 tokenId ) internal virtual {} /** * @dev Hook that is called after any transfer of tokens. This includes * minting and burning. * * Calling conditions: * * - when `from` and `to` are both non-zero. * - `from` and `to` are never both zero. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _afterTokenTransfer( address from, address to, uint256 tokenId ) internal virtual {} }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/ERC721Enumerable.sol) pragma solidity ^0.8.0; import "./ERC721.sol"; import "./IERC721Enumerable.sol"; /** * @dev This implements an optional extension of {ERC721} defined in the EIP that adds * enumerability of all the token ids in the contract as well as all token ids owned by each * account. */ abstract contract ERC721Enumerable is ERC721, IERC721Enumerable { // Mapping from owner to list of owned token IDs mapping(address => mapping(uint256 => uint256)) private _ownedTokens; // Mapping from token ID to index of the owner tokens list mapping(uint256 => uint256) private _ownedTokensIndex; // Array with all token ids, used for enumeration uint256[] private _allTokens; // Mapping from token id to position in the allTokens array mapping(uint256 => uint256) private _allTokensIndex; /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override(ERC721) returns (bool) { return interfaceId == type(IERC721Enumerable).interfaceId || super.supportsInterface(interfaceId); } /** * @dev See {IERC721Enumerable-tokenOfOwnerByIndex}. */ function tokenOfOwnerByIndex(address owner, uint256 index) public view virtual override returns (uint256) { require( index < ERC721.balanceOf(owner), "ERC721Enumerable: owner index out of bounds" ); return _ownedTokens[owner][index]; } /** * @dev See {IERC721Enumerable-totalSupply}. */ function totalSupply() public view virtual override returns (uint256) { return _allTokens.length; } /** * @dev See {IERC721Enumerable-tokenByIndex}. */ function tokenByIndex(uint256 index) public view virtual override returns (uint256) { require( index < ERC721Enumerable.totalSupply(), "ERC721Enumerable: global index out of bounds" ); return _allTokens[index]; } /** * @dev Hook that is called before any token transfer. This includes minting * and burning. * * Calling conditions: * * - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be * transferred to `to`. * - When `from` is zero, `tokenId` will be minted for `to`. * - When `to` is zero, ``from``'s `tokenId` will be burned. * - `from` cannot be the zero address. * - `to` cannot be the zero address. * * To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks]. */ function _beforeTokenTransfer( address from, address to, uint256 tokenId ) internal virtual override { super._beforeTokenTransfer(from, to, tokenId); if (from == address(0)) { _addTokenToAllTokensEnumeration(tokenId); } else if (from != to) { _removeTokenFromOwnerEnumeration(from, tokenId); } if (to == address(0)) { _removeTokenFromAllTokensEnumeration(tokenId); } else if (to != from) { _addTokenToOwnerEnumeration(to, tokenId); } } /** * @dev Private function to add a token to this extension's ownership-tracking data structures. * @param to address representing the new owner of the given token ID * @param tokenId uint256 ID of the token to be added to the tokens list of the given address */ function _addTokenToOwnerEnumeration(address to, uint256 tokenId) private { uint256 length = ERC721.balanceOf(to); _ownedTokens[to][length] = tokenId; _ownedTokensIndex[tokenId] = length; } /** * @dev Private function to add a token to this extension's token tracking data structures. * @param tokenId uint256 ID of the token to be added to the tokens list */ function _addTokenToAllTokensEnumeration(uint256 tokenId) private { _allTokensIndex[tokenId] = _allTokens.length; _allTokens.push(tokenId); } /** * @dev Private function to remove a token from this extension's ownership-tracking data structures. Note that * while the token is not assigned a new owner, the `_ownedTokensIndex` mapping is _not_ updated: this allows for * gas optimizations e.g. when performing a transfer operation (avoiding double writes). * This has O(1) time complexity, but alters the order of the _ownedTokens array. * @param from address representing the previous owner of the given token ID * @param tokenId uint256 ID of the token to be removed from the tokens list of the given address */ function _removeTokenFromOwnerEnumeration(address from, uint256 tokenId) private { // To prevent a gap in from's tokens array, we store the last token in the index of the token to delete, and // then delete the last slot (swap and pop). uint256 lastTokenIndex = ERC721.balanceOf(from) - 1; uint256 tokenIndex = _ownedTokensIndex[tokenId]; // When the token to delete is the last token, the swap operation is unnecessary if (tokenIndex != lastTokenIndex) { uint256 lastTokenId = _ownedTokens[from][lastTokenIndex]; _ownedTokens[from][tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token _ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index } // This also deletes the contents at the last position of the array delete _ownedTokensIndex[tokenId]; delete _ownedTokens[from][lastTokenIndex]; } /** * @dev Private function to remove a token from this extension's token tracking data structures. * This has O(1) time complexity, but alters the order of the _allTokens array. * @param tokenId uint256 ID of the token to be removed from the tokens list */ function _removeTokenFromAllTokensEnumeration(uint256 tokenId) private { // To prevent a gap in the tokens array, we store the last token in the index of the token to delete, and // then delete the last slot (swap and pop). uint256 lastTokenIndex = _allTokens.length - 1; uint256 tokenIndex = _allTokensIndex[tokenId]; // When the token to delete is the last token, the swap operation is unnecessary. However, since this occurs so // rarely (when the last minted token is burnt) that we still do the swap here to avoid the gas cost of adding // an 'if' statement (like in _removeTokenFromOwnerEnumeration) uint256 lastTokenId = _allTokens[lastTokenIndex]; _allTokens[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token _allTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index // This also deletes the contents at the last position of the array delete _allTokensIndex[tokenId]; _allTokens.pop(); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @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. * * ``` * 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. */ 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 of the value in the `values` array, plus 1 because index 0 // means a value is not in the set. mapping(bytes32 => uint256) _indexes; } /** * @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._indexes[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 read and store the value's index to prevent multiple reads from the same storage slot uint256 valueIndex = set._indexes[value]; if (valueIndex != 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 toDeleteIndex = valueIndex - 1; uint256 lastIndex = set._values.length - 1; if (lastIndex != toDeleteIndex) { bytes32 lastvalue = set._values[lastIndex]; // Move the last value to the index where the value to delete is set._values[toDeleteIndex] = lastvalue; // Update the index for the moved value set._indexes[lastvalue] = valueIndex; // Replace lastvalue's index to valueIndex } // Delete the slot where the moved value was stored set._values.pop(); // Delete the index for the deleted slot delete set._indexes[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._indexes[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]; } // 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); } // 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)))); } // 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 on 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)); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC1155/IERC1155.sol) pragma solidity ^0.8.0; import "./IERC165.sol"; /** * @dev Required interface of an ERC1155 compliant contract, as defined in the * https://eips.ethereum.org/EIPS/eip-1155[EIP]. * * _Available since v3.1._ */ interface IERC1155 is IERC165 { /** * @dev Emitted when `value` tokens of token 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 amount of tokens of token type `id` owned by `account`. * * Requirements: * * - `account` cannot be the zero address. */ 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 caller. */ 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 `amount` tokens of token type `id` from `from` to `to`. * * Emits a {TransferSingle} event. * * Requirements: * * - `to` cannot be the zero address. * - If the caller is not `from`, it must be have been approved to spend ``from``'s tokens via {setApprovalForAll}. * - `from` must have a balance of tokens of type `id` of at least `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 amount, bytes calldata data ) external; /** * @dev xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {safeTransferFrom}. * * Emits a {TransferBatch} event. * * Requirements: * * - `ids` and `amounts` 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 amounts, bytes calldata data ) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev Interface of the ERC165 standard, as defined in the * https://eips.ethereum.org/EIPS/eip-165[EIP]. * * 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[EIP 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 pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @dev Returns the amount of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the amount of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves `amount` tokens from the caller's account to `recipient`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address recipient, uint256 amount) 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 `amount` 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 amount) external returns (bool); /** * @dev Moves `amount` tokens from `sender` to `recipient` using the * allowance mechanism. `amount` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom( address sender, address recipient, uint256 amount ) external returns (bool); /** * @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 ); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721.sol) pragma solidity ^0.8.0; import "./IERC165.sol"; /** * @dev Required interface of an ERC721 compliant contract. */ interface IERC721 { /** * @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 ERC721 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 be 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: Usage of this method is discouraged, use {safeTransferFrom} whenever possible. * * 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 caller. * * 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); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (token/ERC721/extensions/IERC721Enumerable.sol) pragma solidity ^0.8.0; import "./IERC721.sol"; /** * @title ERC-721 Non-Fungible Token Standard, optional enumeration extension * @dev See https://eips.ethereum.org/EIPS/eip-721 */ interface IERC721Enumerable is IERC721 { /** * @dev Returns the total amount of tokens stored by the contract. */ function totalSupply() external view returns (uint256); /** * @dev Returns a token ID owned by `owner` at a given `index` of its token list. * Use along with {balanceOf} to enumerate all of ``owner``'s tokens. */ function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256); /** * @dev Returns a token ID at a given `index` of all the tokens stored by the contract. * Use along with {totalSupply} to enumerate all tokens. */ function tokenByIndex(uint256 index) external view returns (uint256); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol) pragma solidity ^0.8.0; import "./IERC721.sol"; /** * @title ERC-721 Non-Fungible Token Standard, optional metadata extension * @dev See https://eips.ethereum.org/EIPS/eip-721 */ interface IERC721Metadata is IERC721 { /** * @dev Returns the token collection name. */ function name() external view returns (string memory); /** * @dev Returns the token collection symbol. */ function symbol() external view returns (string memory); /** * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token. */ function tokenURI(uint256 tokenId) external view returns (string memory); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721Receiver.sol) pragma solidity ^0.8.0; /** * @title ERC721 token receiver interface * @dev Interface for any contract that wants to support safeTransfers * from ERC721 asset contracts. */ interface IERC721Receiver { /** * @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom} * by `operator` from `from`, this function is called. * * It must return its Solidity selector to confirm the token transfer. * If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted. * * The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`. */ function onERC721Received( address operator, address from, uint256 tokenId, bytes calldata data ) external returns (bytes4); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "./Context.sol"; /** * @dev Contract module which provides a basic access control mechanism, where * there is an account (an owner) that can be granted exclusive access to * specific functions. * * By default, the owner account will be the one that deploys the contract. 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. */ contract Ownable is Context { address private _owner; event OwnershipTransferred( address indexed previousOwner, address indexed newOwner ); /** * @dev Initializes the contract setting the deployer as the initial owner. */ constructor() { address msgSender = _msgSender(); _owner = msgSender; emit OwnershipTransferred(address(0), msgSender); } /** * @dev Returns the address of the current owner. */ function owner() public view returns (address) { return _owner; } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { require(_owner == _msgSender(), "Ownable: caller is not the owner"); _; } /** * @dev Leaves the contract without owner. It will not be possible to call * `onlyOwner` functions anymore. Can only be called by the current owner. * * NOTE: Renouncing ownership will leave the contract without an owner, * thereby removing any functionality that is only available to the owner. */ function renounceOwnership() public virtual onlyOwner { emit OwnershipTransferred(_owner, address(0)); _owner = 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 { require( newOwner != address(0), "Ownable: new owner is the zero address" ); emit OwnershipTransferred(_owner, newOwner); _owner = newOwner; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/math/SafeCast.sol) pragma solidity ^0.8.0; /** * @dev Wrappers over Solidity's uintXX/intXX 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. * * Can be combined with {SafeMath} and {SignedSafeMath} to extend it to smaller types, by performing * all math on `uint256` and `int256` and then downcasting. */ library SafeCast { /** * @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) { require( value <= type(uint224).max, "SafeCast: value doesn't fit in 224 bits" ); return uint224(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 * * _Available since v4.7._ */ function toUint184(uint256 value) internal pure returns (uint184) { require(value <= type(uint184).max, "SafeCast: value doesn't fit in 184 bits"); return uint184(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) { require( value <= type(uint128).max, "SafeCast: value doesn't fit in 128 bits" ); return uint128(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) { require( value <= type(uint96).max, "SafeCast: value doesn't fit in 96 bits" ); return uint96(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) { require( value <= type(uint64).max, "SafeCast: value doesn't fit in 64 bits" ); return uint64(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 * * _Available since v4.7._ */ function toUint48(uint256 value) internal pure returns (uint48) { require(value <= type(uint48).max, "SafeCast: value doesn't fit in 48 bits"); return uint48(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) { require( value <= type(uint32).max, "SafeCast: value doesn't fit in 32 bits" ); return uint32(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) { require( value <= type(uint16).max, "SafeCast: value doesn't fit in 16 bits" ); 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) { require( value <= type(uint8).max, "SafeCast: value doesn't fit in 8 bits" ); 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) { require(value >= 0, "SafeCast: value must be positive"); return uint256(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 * * _Available since v3.1._ */ function toInt128(int256 value) internal pure returns (int128) { require( value >= type(int128).min && value <= type(int128).max, "SafeCast: value doesn't fit in 128 bits" ); return int128(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 * * _Available since v3.1._ */ function toInt64(int256 value) internal pure returns (int64) { require( value >= type(int64).min && value <= type(int64).max, "SafeCast: value doesn't fit in 64 bits" ); return int64(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 * * _Available since v3.1._ */ function toInt32(int256 value) internal pure returns (int32) { require( value >= type(int32).min && value <= type(int32).max, "SafeCast: value doesn't fit in 32 bits" ); return int32(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 * * _Available since v3.1._ */ function toInt16(int256 value) internal pure returns (int16) { require( value >= type(int16).min && value <= type(int16).max, "SafeCast: value doesn't fit in 16 bits" ); return int16(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. * * _Available since v3.1._ */ function toInt8(int256 value) internal pure returns (int8) { require( value >= type(int8).min && value <= type(int8).max, "SafeCast: value doesn't fit in 8 bits" ); return int8(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 require( value <= uint256(type(int256).max), "SafeCast: value doesn't fit in an int256" ); return int256(value); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (token/ERC20/utils/SafeERC20.sol) pragma solidity ^0.8.0; import "./IERC20.sol"; import "./draft-IERC20Permit.sol"; import "./Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC20 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 { using Address for address; function safeTransfer( IERC20 token, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); } function safeTransferFrom( IERC20 token, address from, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); } /** * @dev Deprecated. This function has issues similar to the ones found in * {IERC20-approve}, and its usage is discouraged. * * Whenever possible, use {safeIncreaseAllowance} and * {safeDecreaseAllowance} instead. */ function safeApprove( IERC20 token, address spender, uint256 value ) internal { // safeApprove should only be called when setting an initial allowance, // or when resetting it to zero. To increase and decrease it, use // 'safeIncreaseAllowance' and 'safeDecreaseAllowance' require( (value == 0) || (token.allowance(address(this), spender) == 0), "SafeERC20: approve from non-zero to non-zero allowance" ); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); } function safeIncreaseAllowance( IERC20 token, address spender, uint256 value ) internal { uint256 newAllowance = token.allowance(address(this), spender) + value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance( IERC20 token, address spender, uint256 value ) internal { unchecked { uint256 oldAllowance = token.allowance(address(this), spender); require(oldAllowance >= value, "SafeERC20: decreased allowance below zero"); uint256 newAllowance = oldAllowance - value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } } function safePermit( IERC20Permit token, address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) internal { uint256 nonceBefore = token.nonces(owner); token.permit(owner, spender, value, deadline, v, r, s); uint256 nonceAfter = token.nonces(owner); require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed"); } /** * @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). */ function _callOptionalReturn(IERC20 token, bytes memory data) private { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that // the target address contains contract code and also asserts for success in the low-level call. bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed"); if (returndata.length > 0) { // Return data is optional require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /** * @dev String operations. */ library Strings { bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef"; /** * @dev Converts a `uint256` to its ASCII `string` decimal representation. */ function toString(uint256 value) internal pure returns (string memory) { // Inspired by OraclizeAPI's implementation - MIT licence // https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol if (value == 0) { return "0"; } uint256 temp = value; uint256 digits; while (temp != 0) { digits++; temp /= 10; } bytes memory buffer = new bytes(digits); while (value != 0) { digits -= 1; buffer[digits] = bytes1(uint8(48 + uint256(value % 10))); value /= 10; } return string(buffer); } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation. */ function toHexString(uint256 value) internal pure returns (string memory) { if (value == 0) { return "0x00"; } uint256 temp = value; uint256 length = 0; while (temp != 0) { length++; temp >>= 8; } return toHexString(value, length); } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length. */ function toHexString(uint256 value, uint256 length) internal pure returns (string memory) { 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_SYMBOLS[value & 0xf]; value >>= 4; } require(value == 0, "Strings: hex length insufficient"); return string(buffer); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC20 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. */ 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]. */ 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 v4.6.0) (proxy/utils/Initializable.sol) pragma solidity ^0.8.0; import "../contracts/Address.sol"; /** * @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] * ``` * 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 Indicates that the contract has been initialized. * @custom:oz-retyped-from bool */ uint8 private _initialized; /** * @dev Indicates that the contract is in the process of being initialized. */ bool private _initializing; /** * @dev Triggered when the contract has been initialized or reinitialized. */ event Initialized(uint8 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. Equivalent to `reinitializer(1)`. */ modifier initializer() { bool isTopLevelCall = !_initializing; require( (isTopLevelCall && _initialized < 1) || (!Address.isContract(address(this)) && _initialized == 1), "Initializable: contract is already initialized" ); _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. * * `initializer` is equivalent to `reinitializer(1)`, so 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. * * 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. */ modifier reinitializer(uint8 version) { require( !_initializing && _initialized < version, "Initializable: contract is already initialized" ); _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() { require(_initializing, "Initializable: contract is not initializing"); _; } /** * @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. */ function _disableInitializers() internal virtual { require(!_initializing, "Initializable: contract is initializing"); if (_initialized < type(uint8).max) { _initialized = type(uint8).max; emit Initialized(type(uint8).max); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol) pragma solidity ^0.8.0; import "./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 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; uint256 private _status; function __ReentrancyGuard_init() internal onlyInitializing { __ReentrancyGuard_init_unchained(); } function __ReentrancyGuard_init_unchained() internal onlyInitializing { _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() { // On the first call to nonReentrant, _notEntered will be true require(_status != _ENTERED, "ReentrancyGuard: reentrant call"); // Any calls to nonReentrant after this point will fail _status = _ENTERED; _; // By storing the original value once again, a refund is triggered (see // https://eips.ethereum.org/EIPS/eip-2200) _status = _NOT_ENTERED; } /** * @dev This empty reserved space is put in place to allow future versions to add new * variables without shifting down storage in the inheritance chain. * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps */ uint256[49] private __gap; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; // prettier-ignore enum OrderType { // 0: no partial fills, anyone can execute FULL_OPEN, // 1: partial fills supported, anyone can execute PARTIAL_OPEN, // 2: no partial fills, only offerer or zone can execute FULL_RESTRICTED, // 3: partial fills supported, only offerer or zone can execute PARTIAL_RESTRICTED } // prettier-ignore enum BasicOrderType { // 0: no partial fills, anyone can execute ETH_TO_ERC721_FULL_OPEN, // 1: partial fills supported, anyone can execute ETH_TO_ERC721_PARTIAL_OPEN, // 2: no partial fills, only offerer or zone can execute ETH_TO_ERC721_FULL_RESTRICTED, // 3: partial fills supported, only offerer or zone can execute ETH_TO_ERC721_PARTIAL_RESTRICTED, // 4: no partial fills, anyone can execute ETH_TO_ERC1155_FULL_OPEN, // 5: partial fills supported, anyone can execute ETH_TO_ERC1155_PARTIAL_OPEN, // 6: no partial fills, only offerer or zone can execute ETH_TO_ERC1155_FULL_RESTRICTED, // 7: partial fills supported, only offerer or zone can execute ETH_TO_ERC1155_PARTIAL_RESTRICTED, // 8: no partial fills, anyone can execute ERC20_TO_ERC721_FULL_OPEN, // 9: partial fills supported, anyone can execute ERC20_TO_ERC721_PARTIAL_OPEN, // 10: no partial fills, only offerer or zone can execute ERC20_TO_ERC721_FULL_RESTRICTED, // 11: partial fills supported, only offerer or zone can execute ERC20_TO_ERC721_PARTIAL_RESTRICTED, // 12: no partial fills, anyone can execute ERC20_TO_ERC1155_FULL_OPEN, // 13: partial fills supported, anyone can execute ERC20_TO_ERC1155_PARTIAL_OPEN, // 14: no partial fills, only offerer or zone can execute ERC20_TO_ERC1155_FULL_RESTRICTED, // 15: partial fills supported, only offerer or zone can execute ERC20_TO_ERC1155_PARTIAL_RESTRICTED, // 16: no partial fills, anyone can execute ERC721_TO_ERC20_FULL_OPEN, // 17: partial fills supported, anyone can execute ERC721_TO_ERC20_PARTIAL_OPEN, // 18: no partial fills, only offerer or zone can execute ERC721_TO_ERC20_FULL_RESTRICTED, // 19: partial fills supported, only offerer or zone can execute ERC721_TO_ERC20_PARTIAL_RESTRICTED, // 20: no partial fills, anyone can execute ERC1155_TO_ERC20_FULL_OPEN, // 21: partial fills supported, anyone can execute ERC1155_TO_ERC20_PARTIAL_OPEN, // 22: no partial fills, only offerer or zone can execute ERC1155_TO_ERC20_FULL_RESTRICTED, // 23: partial fills supported, only offerer or zone can execute ERC1155_TO_ERC20_PARTIAL_RESTRICTED } // prettier-ignore enum BasicOrderRouteType { // 0: provide Ether (or other native token) to receive offered ERC721 item. ETH_TO_ERC721, // 1: provide Ether (or other native token) to receive offered ERC1155 item. ETH_TO_ERC1155, // 2: provide ERC20 item to receive offered ERC721 item. ERC20_TO_ERC721, // 3: provide ERC20 item to receive offered ERC1155 item. ERC20_TO_ERC1155, // 4: provide ERC721 item to receive offered ERC20 item. ERC721_TO_ERC20, // 5: provide ERC1155 item to receive offered ERC20 item. ERC1155_TO_ERC20 } // prettier-ignore enum ItemType { // 0: ETH on mainnet, MATIC on polygon, etc. NATIVE, // 1: ERC20 items (ERC777 and ERC20 analogues could also technically work) ERC20, // 2: ERC721 items ERC721, // 3: ERC1155 items ERC1155, // 4: ERC721 items where a number of tokenIds are supported ERC721_WITH_CRITERIA, // 5: ERC1155 items where a number of ids are supported ERC1155_WITH_CRITERIA } // prettier-ignore enum Side { // 0: Items that can be spent OFFER, // 1: Items that must be received CONSIDERATION }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import { OrderType, BasicOrderType, ItemType, Side } from "./ConsiderationEnums.sol"; /** * @dev An order contains eleven components: an offerer, a zone (or account that * can cancel the order or restrict who can fulfill the order depending on * the type), the order type (specifying partial fill support as well as * restricted order status), the start and end time, a hash that will be * provided to the zone when validating restricted orders, a salt, a key * corresponding to a given conduit, a counter, and an arbitrary number of * offer items that can be spent along with consideration items that must * be received by their respective recipient. */ struct OrderComponents { address offerer; address zone; OfferItem[] offer; ConsiderationItem[] consideration; OrderType orderType; uint256 startTime; uint256 endTime; bytes32 zoneHash; uint256 salt; bytes32 conduitKey; uint256 counter; } /** * @dev An offer item has five components: an item type (ETH or other native * tokens, ERC20, ERC721, and ERC1155, as well as criteria-based ERC721 and * ERC1155), a token address, a dual-purpose "identifierOrCriteria" * component that will either represent a tokenId or a merkle root * depending on the item type, and a start and end amount that support * increasing or decreasing amounts over the duration of the respective * order. */ struct OfferItem { ItemType itemType; address token; uint256 identifierOrCriteria; uint256 startAmount; uint256 endAmount; } /** * @dev A consideration item has the same five components as an offer item and * an additional sixth component designating the required recipient of the * item. */ struct ConsiderationItem { ItemType itemType; address token; uint256 identifierOrCriteria; uint256 startAmount; uint256 endAmount; address payable recipient; } /** * @dev A spent item is translated from a utilized offer item and has four * components: an item type (ETH or other native tokens, ERC20, ERC721, and * ERC1155), a token address, a tokenId, and an amount. */ struct SpentItem { ItemType itemType; address token; uint256 identifier; uint256 amount; } /** * @dev A received item is translated from a utilized consideration item and has * the same four components as a spent item, as well as an additional fifth * component designating the required recipient of the item. */ struct ReceivedItem { ItemType itemType; address token; uint256 identifier; uint256 amount; address payable recipient; } /** * @dev For basic orders involving ETH / native / ERC20 <=> ERC721 / ERC1155 * matching, a group of six functions may be called that only requires a * subset of the usual order arguments. Note the use of a "basicOrderType" * enum; this represents both the usual order type as well as the "route" * of the basic order (a simple derivation function for the basic order * type is `basicOrderType = orderType + (4 * basicOrderRoute)`.) */ struct BasicOrderParameters { // calldata offset address considerationToken; // 0x24 uint256 considerationIdentifier; // 0x44 uint256 considerationAmount; // 0x64 address payable offerer; // 0x84 address zone; // 0xa4 address offerToken; // 0xc4 uint256 offerIdentifier; // 0xe4 uint256 offerAmount; // 0x104 BasicOrderType basicOrderType; // 0x124 uint256 startTime; // 0x144 uint256 endTime; // 0x164 bytes32 zoneHash; // 0x184 uint256 salt; // 0x1a4 bytes32 offererConduitKey; // 0x1c4 bytes32 fulfillerConduitKey; // 0x1e4 uint256 totalOriginalAdditionalRecipients; // 0x204 AdditionalRecipient[] additionalRecipients; // 0x224 bytes signature; // 0x244 // Total length, excluding dynamic array data: 0x264 (580) } /** * @dev Basic orders can supply any number of additional recipients, with the * implied assumption that they are supplied from the offered ETH (or other * native token) or ERC20 token for the order. */ struct AdditionalRecipient { uint256 amount; address payable recipient; } /** * @dev The full set of order components, with the exception of the counter, * must be supplied when fulfilling more sophisticated orders or groups of * orders. The total number of original consideration items must also be * supplied, as the caller may specify additional consideration items. */ struct OrderParameters { address offerer; // 0x00 address zone; // 0x20 OfferItem[] offer; // 0x40 ConsiderationItem[] consideration; // 0x60 OrderType orderType; // 0x80 uint256 startTime; // 0xa0 uint256 endTime; // 0xc0 bytes32 zoneHash; // 0xe0 uint256 salt; // 0x100 bytes32 conduitKey; // 0x120 uint256 totalOriginalConsiderationItems; // 0x140 // offer.length // 0x160 } /** * @dev Orders require a signature in addition to the other order parameters. */ struct Order { OrderParameters parameters; bytes signature; } /** * @dev Advanced orders include a numerator (i.e. a fraction to attempt to fill) * and a denominator (the total size of the order) in addition to the * signature and other order parameters. It also supports an optional field * for supplying extra data; this data will be included in a staticcall to * `isValidOrderIncludingExtraData` on the zone for the order if the order * type is restricted and the offerer or zone are not the caller. */ struct AdvancedOrder { OrderParameters parameters; uint120 numerator; uint120 denominator; bytes signature; bytes extraData; } /** * @dev Orders can be validated (either explicitly via `validate`, or as a * consequence of a full or partial fill), specifically cancelled (they can * also be cancelled in bulk via incrementing a per-zone counter), and * partially or fully filled (with the fraction filled represented by a * numerator and denominator). */ struct OrderStatus { bool isValidated; bool isCancelled; uint120 numerator; uint120 denominator; } /** * @dev A criteria resolver specifies an order, side (offer vs. consideration), * and item index. It then provides a chosen identifier (i.e. tokenId) * alongside a merkle proof demonstrating the identifier meets the required * criteria. */ struct CriteriaResolver { uint256 orderIndex; Side side; uint256 index; uint256 identifier; bytes32[] criteriaProof; } /** * @dev A fulfillment is applied to a group of orders. It decrements a series of * offer and consideration items, then generates a single execution * element. A given fulfillment can be applied to as many offer and * consideration items as desired, but must contain at least one offer and * at least one consideration that match. The fulfillment must also remain * consistent on all key parameters across all offer items (same offerer, * token, type, tokenId, and conduit preference) as well as across all * consideration items (token, type, tokenId, and recipient). */ struct Fulfillment { FulfillmentComponent[] offerComponents; FulfillmentComponent[] considerationComponents; } /** * @dev Each fulfillment component contains one index referencing a specific * order and another referencing a specific offer or consideration item. */ struct FulfillmentComponent { uint256 orderIndex; uint256 itemIndex; } /** * @dev An execution is triggered once all consideration items have been zeroed * out. It sends the item in question from the offerer to the item's * recipient, optionally sourcing approvals from either this contract * directly or from the offerer's chosen conduit if one is specified. An * execution is not provided as an argument, but rather is derived via * orders, criteria resolvers, and fulfillments (where the total number of * executions will be less than or equal to the total number of indicated * fulfillments) and returned as part of `matchOrders`. */ struct Execution { ReceivedItem item; address offerer; bytes32 conduitKey; }
//SPDX-License-Identifier: MIT pragma solidity ^0.8.0; import "../openzeppelin/contracts/IERC20.sol"; import "../openzeppelin/contracts/SafeERC20.sol"; import "../openzeppelin/contracts/SafeCast.sol"; import "../openzeppelin/contracts/Ownable.sol"; import "../openzeppelin/contracts/ERC721Enumerable.sol"; /** * @title ApeCoin Staking Contract * @notice Stake ApeCoin across four different pools that release hourly rewards * @author HorizenLabs */ contract ApeCoinStaking is Ownable { using SafeCast for uint256; using SafeCast for int256; /// @notice State for ApeCoin, BAYC, MAYC, and Pair Pools struct Pool { uint48 lastRewardedTimestampHour; uint16 lastRewardsRangeIndex; uint96 stakedAmount; uint96 accumulatedRewardsPerShare; TimeRange[] timeRanges; } /// @notice Pool rules valid for a given duration of time. /// @dev All TimeRange timestamp values must represent whole hours struct TimeRange { uint48 startTimestampHour; uint48 endTimestampHour; uint96 rewardsPerHour; uint96 capPerPosition; } /// @dev Convenience struct for front-end applications struct PoolUI { uint256 poolId; uint256 stakedAmount; TimeRange currentTimeRange; } /// @dev Per address amount and reward tracking struct Position { uint256 stakedAmount; int256 rewardsDebt; } mapping (address => Position) public addressPosition; /// @dev Struct for depositing and withdrawing from the BAYC and MAYC NFT pools struct SingleNft { uint32 tokenId; uint224 amount; } /// @dev Struct for depositing from the BAKC (Pair) pool struct PairNftDepositWithAmount { uint32 mainTokenId; uint32 bakcTokenId; uint184 amount; } /// @dev Struct for withdrawing from the BAKC (Pair) pool struct PairNftWithdrawWithAmount { uint32 mainTokenId; uint32 bakcTokenId; uint184 amount; bool isUncommit; } /// @dev Struct for claiming from an NFT pool struct PairNft { uint128 mainTokenId; uint128 bakcTokenId; } /// @dev NFT paired status. Can be used bi-directionally (BAYC/MAYC -> BAKC) or (BAKC -> BAYC/MAYC) struct PairingStatus { uint248 tokenId; bool isPaired; } // @dev UI focused payload struct DashboardStake { uint256 poolId; uint256 tokenId; uint256 deposited; uint256 unclaimed; uint256 rewards24hr; DashboardPair pair; } /// @dev Sub struct for DashboardStake struct DashboardPair { uint256 mainTokenId; uint256 mainTypePoolId; } /// @dev Placeholder for pair status, used by ApeCoin Pool DashboardPair private NULL_PAIR = DashboardPair(0, 0); /// @notice Internal ApeCoin amount for distributing staking reward claims IERC20 public immutable apeCoin; uint256 private constant APE_COIN_PRECISION = 1e18; uint256 private constant MIN_DEPOSIT = 1 * APE_COIN_PRECISION; uint256 private constant SECONDS_PER_HOUR = 3600; uint256 private constant SECONDS_PER_MINUTE = 60; uint256 constant APECOIN_POOL_ID = 0; uint256 constant BAYC_POOL_ID = 1; uint256 constant MAYC_POOL_ID = 2; uint256 constant BAKC_POOL_ID = 3; Pool[4] public pools; /// @dev NFT contract mapping per pool mapping(uint256 => ERC721Enumerable) public nftContracts; /// @dev poolId => tokenId => nft position mapping(uint256 => mapping(uint256 => Position)) public nftPosition; /// @dev main type pool ID: 1: BAYC 2: MAYC => main token ID => bakc token ID mapping(uint256 => mapping(uint256 => PairingStatus)) public mainToBakc; /// @dev bakc Token ID => main type pool ID: 1: BAYC 2: MAYC => main token ID mapping(uint256 => mapping(uint256 => PairingStatus)) public bakcToMain; /** Custom Events */ event UpdatePool( uint256 indexed poolId, uint256 lastRewardedBlock, uint256 stakedAmount, uint256 accumulatedRewardsPerShare ); event Deposit( address indexed user, uint256 amount, address recipient ); event DepositNft( address indexed user, uint256 indexed poolId, uint256 amount, uint256 tokenId ); event DepositPairNft( address indexed user, uint256 amount, uint256 mainTypePoolId, uint256 mainTokenId, uint256 bakcTokenId ); event Withdraw( address indexed user, uint256 amount, address recipient ); event WithdrawNft( address indexed user, uint256 indexed poolId, uint256 amount, address recipient, uint256 tokenId ); event WithdrawPairNft( address indexed user, uint256 amount, uint256 mainTypePoolId, uint256 mainTokenId, uint256 bakcTokenId ); event ClaimRewards( address indexed user, uint256 amount, address recipient ); event ClaimRewardsNft( address indexed user, uint256 indexed poolId, uint256 amount, uint256 tokenId ); event ClaimRewardsPairNft( address indexed user, uint256 amount, uint256 mainTypePoolId, uint256 mainTokenId, uint256 bakcTokenId ); error DepositMoreThanOneAPE(); error InvalidPoolId(); error StartMustBeGreaterThanEnd(); error StartNotWholeHour(); error EndNotWholeHour(); error StartMustEqualLastEnd(); error CallerNotOwner(); error MainTokenNotOwnedOrPaired(); error BAKCNotOwnedOrPaired(); error BAKCAlreadyPaired(); error ExceededCapAmount(); error NotOwnerOfMain(); error NotOwnerOfBAKC(); error ProvidedTokensNotPaired(); error ExceededStakedAmount(); error NeitherTokenInPairOwnedByCaller(); error SplitPairCantPartiallyWithdraw(); error UncommitWrongParameters(); /** * @notice Construct a new ApeCoinStaking instance * @param _apeCoinContractAddress The ApeCoin ERC20 contract address * @param _baycContractAddress The BAYC NFT contract address * @param _maycContractAddress The MAYC NFT contract address * @param _bakcContractAddress The BAKC NFT contract address */ constructor( address _apeCoinContractAddress, address _baycContractAddress, address _maycContractAddress, address _bakcContractAddress ) { apeCoin = IERC20(_apeCoinContractAddress); nftContracts[BAYC_POOL_ID] = ERC721Enumerable(_baycContractAddress); nftContracts[MAYC_POOL_ID] = ERC721Enumerable(_maycContractAddress); nftContracts[BAKC_POOL_ID] = ERC721Enumerable(_bakcContractAddress); } // Deposit/Commit Methods /** * @notice Deposit ApeCoin to the ApeCoin Pool * @param _amount Amount in ApeCoin * @param _recipient Address the deposit it stored to * @dev ApeCoin deposit must be >= 1 ApeCoin */ function depositApeCoin(uint256 _amount, address _recipient) public { if (_amount < MIN_DEPOSIT) revert DepositMoreThanOneAPE(); updatePool(APECOIN_POOL_ID); Position storage position = addressPosition[_recipient]; _deposit(APECOIN_POOL_ID, position, _amount); apeCoin.transferFrom(msg.sender, address(this), _amount); emit Deposit(msg.sender, _amount, _recipient); } /** * @notice Deposit ApeCoin to the ApeCoin Pool * @param _amount Amount in ApeCoin * @dev Deposit on behalf of msg.sender. ApeCoin deposit must be >= 1 ApeCoin */ function depositSelfApeCoin(uint256 _amount) external { depositApeCoin(_amount, msg.sender); } /** * @notice Deposit ApeCoin to the BAYC Pool * @param _nfts Array of SingleNft structs * @dev Commits 1 or more BAYC NFTs, each with an ApeCoin amount to the BAYC pool.\ * Each BAYC committed must attach an ApeCoin amount >= 1 ApeCoin and <= the BAYC pool cap amount. */ function depositBAYC(SingleNft[] calldata _nfts) external { _depositNft(BAYC_POOL_ID, _nfts); } /** * @notice Deposit ApeCoin to the MAYC Pool * @param _nfts Array of SingleNft structs * @dev Commits 1 or more MAYC NFTs, each with an ApeCoin amount to the MAYC pool.\ * Each MAYC committed must attach an ApeCoin amount >= 1 ApeCoin and <= the MAYC pool cap amount. */ function depositMAYC(SingleNft[] calldata _nfts) external { _depositNft(MAYC_POOL_ID, _nfts); } /** * @notice Deposit ApeCoin to the Pair Pool, where Pair = (BAYC + BAKC) or (MAYC + BAKC) * @param _baycPairs Array of PairNftDepositWithAmount structs * @param _maycPairs Array of PairNftDepositWithAmount structs * @dev Commits 1 or more Pairs, each with an ApeCoin amount to the Pair pool.\ * Each BAKC committed must attach an ApeCoin amount >= 1 ApeCoin and <= the Pair pool cap amount.\ * Example 1: BAYC + BAKC + 1 ApeCoin: [[0, 0, "1000000000000000000"],[]]\ * Example 2: MAYC + BAKC + 1 ApeCoin: [[], [0, 0, "1000000000000000000"]]\ * Example 3: (BAYC + BAKC + 1 ApeCoin) and (MAYC + BAKC + 1 ApeCoin): [[0, 0, "1000000000000000000"], [0, 1, "1000000000000000000"]] */ function depositBAKC(PairNftDepositWithAmount[] calldata _baycPairs, PairNftDepositWithAmount[] calldata _maycPairs) external { updatePool(BAKC_POOL_ID); _depositPairNft(BAYC_POOL_ID, _baycPairs); _depositPairNft(MAYC_POOL_ID, _maycPairs); } // Claim Rewards Methods /** * @notice Claim rewards for msg.sender and send to recipient * @param _recipient Address to send claim reward to */ function claimApeCoin(address _recipient) public { updatePool(APECOIN_POOL_ID); Position storage position = addressPosition[msg.sender]; uint256 rewardsToBeClaimed = _claim(APECOIN_POOL_ID, position, _recipient); emit ClaimRewards(msg.sender, rewardsToBeClaimed, _recipient); } /// @notice Claim and send rewards function claimSelfApeCoin() external { claimApeCoin(msg.sender); } /** * @notice Claim rewards for array of BAYC NFTs and send to recipient * @param _nfts Array of NFTs owned and committed by the msg.sender * @param _recipient Address to send claim reward to */ function claimBAYC(uint256[] calldata _nfts, address _recipient) external { _claimNft(BAYC_POOL_ID, _nfts, _recipient); } /** * @notice Claim rewards for array of BAYC NFTs * @param _nfts Array of NFTs owned and committed by the msg.sender */ function claimSelfBAYC(uint256[] calldata _nfts) external { _claimNft(BAYC_POOL_ID, _nfts, msg.sender); } /** * @notice Claim rewards for array of MAYC NFTs and send to recipient * @param _nfts Array of NFTs owned and committed by the msg.sender * @param _recipient Address to send claim reward to */ function claimMAYC(uint256[] calldata _nfts, address _recipient) external { _claimNft(MAYC_POOL_ID, _nfts, _recipient); } /** * @notice Claim rewards for array of MAYC NFTs * @param _nfts Array of NFTs owned and committed by the msg.sender */ function claimSelfMAYC(uint256[] calldata _nfts) external { _claimNft(MAYC_POOL_ID, _nfts, msg.sender); } /** * @notice Claim rewards for array of Paired NFTs and send to recipient * @param _baycPairs Array of Paired BAYC NFTs owned and committed by the msg.sender * @param _maycPairs Array of Paired MAYC NFTs owned and committed by the msg.sender * @param _recipient Address to send claim reward to */ function claimBAKC(PairNft[] calldata _baycPairs, PairNft[] calldata _maycPairs, address _recipient) public { updatePool(BAKC_POOL_ID); _claimPairNft(BAYC_POOL_ID, _baycPairs, _recipient); _claimPairNft(MAYC_POOL_ID, _maycPairs, _recipient); } /** * @notice Claim rewards for array of Paired NFTs * @param _baycPairs Array of Paired BAYC NFTs owned and committed by the msg.sender * @param _maycPairs Array of Paired MAYC NFTs owned and committed by the msg.sender */ function claimSelfBAKC(PairNft[] calldata _baycPairs, PairNft[] calldata _maycPairs) external { claimBAKC(_baycPairs, _maycPairs, msg.sender); } // Uncommit/Withdraw Methods /** * @notice Withdraw staked ApeCoin from the ApeCoin pool. Performs an automatic claim as part of the withdraw process. * @param _amount Amount of ApeCoin * @param _recipient Address to send withdraw amount and claim to */ function withdrawApeCoin(uint256 _amount, address _recipient) public { updatePool(APECOIN_POOL_ID); Position storage position = addressPosition[msg.sender]; if (_amount == position.stakedAmount) { uint256 rewardsToBeClaimed = _claim(APECOIN_POOL_ID, position, _recipient); emit ClaimRewards(msg.sender, rewardsToBeClaimed, _recipient); } _withdraw(APECOIN_POOL_ID, position, _amount); apeCoin.transfer(_recipient, _amount); emit Withdraw(msg.sender, _amount, _recipient); } /** * @notice Withdraw staked ApeCoin from the ApeCoin pool. If withdraw is total staked amount, performs an automatic claim. * @param _amount Amount of ApeCoin */ function withdrawSelfApeCoin(uint256 _amount) external { withdrawApeCoin(_amount, msg.sender); } /** * @notice Withdraw staked ApeCoin from the BAYC pool. If withdraw is total staked amount, performs an automatic claim. * @param _nfts Array of BAYC NFT's with staked amounts * @param _recipient Address to send withdraw amount and claim to */ function withdrawBAYC(SingleNft[] calldata _nfts, address _recipient) external { _withdrawNft(BAYC_POOL_ID, _nfts, _recipient); } /** * @notice Withdraw staked ApeCoin from the BAYC pool. If withdraw is total staked amount, performs an automatic claim. * @param _nfts Array of BAYC NFT's with staked amounts */ function withdrawSelfBAYC(SingleNft[] calldata _nfts) external { _withdrawNft(BAYC_POOL_ID, _nfts, msg.sender); } /** * @notice Withdraw staked ApeCoin from the MAYC pool. If withdraw is total staked amount, performs an automatic claim. * @param _nfts Array of MAYC NFT's with staked amounts * @param _recipient Address to send withdraw amount and claim to */ function withdrawMAYC(SingleNft[] calldata _nfts, address _recipient) external { _withdrawNft(MAYC_POOL_ID, _nfts, _recipient); } /** * @notice Withdraw staked ApeCoin from the MAYC pool. If withdraw is total staked amount, performs an automatic claim. * @param _nfts Array of MAYC NFT's with staked amounts */ function withdrawSelfMAYC(SingleNft[] calldata _nfts) external { _withdrawNft(MAYC_POOL_ID, _nfts, msg.sender); } /** * @notice Withdraw staked ApeCoin from the Pair pool. If withdraw is total staked amount, performs an automatic claim. * @param _baycPairs Array of Paired BAYC NFT's with staked amounts and isUncommit boolean * @param _maycPairs Array of Paired MAYC NFT's with staked amounts and isUncommit boolean * @dev if pairs have split ownership and BAKC is attempting a withdraw, the withdraw must be for the total staked amount */ function withdrawBAKC(PairNftWithdrawWithAmount[] calldata _baycPairs, PairNftWithdrawWithAmount[] calldata _maycPairs) external { updatePool(BAKC_POOL_ID); _withdrawPairNft(BAYC_POOL_ID, _baycPairs); _withdrawPairNft(MAYC_POOL_ID, _maycPairs); } // Time Range Methods /** * @notice Add single time range with a given rewards per hour for a given pool * @dev In practice one Time Range will represent one quarter (defined by `_startTimestamp`and `_endTimeStamp` as whole hours) * where the rewards per hour is constant for a given pool. * @param _poolId Available pool values 0-3 * @param _amount Total amount of ApeCoin to be distributed over the range * @param _startTimestamp Whole hour timestamp representation * @param _endTimeStamp Whole hour timestamp representation * @param _capPerPosition Per position cap amount determined by poolId */ function addTimeRange( uint256 _poolId, uint256 _amount, uint256 _startTimestamp, uint256 _endTimeStamp, uint256 _capPerPosition) external onlyOwner { if (_poolId > BAKC_POOL_ID) revert InvalidPoolId(); if (_startTimestamp >= _endTimeStamp) revert StartMustBeGreaterThanEnd(); if (getMinute(_startTimestamp) > 0 || getSecond(_startTimestamp) > 0) revert StartNotWholeHour(); if (getMinute(_endTimeStamp) > 0 || getSecond(_endTimeStamp) > 0) revert EndNotWholeHour(); Pool storage pool = pools[_poolId]; uint256 length = pool.timeRanges.length; if (length > 0) { if (_startTimestamp != pool.timeRanges[length - 1].endTimestampHour) revert StartMustEqualLastEnd(); } uint256 hoursInSeconds = _endTimeStamp - _startTimestamp; uint256 rewardsPerHour = _amount * SECONDS_PER_HOUR / hoursInSeconds; TimeRange memory next = TimeRange(_startTimestamp.toUint48(), _endTimeStamp.toUint48(), rewardsPerHour.toUint96(), _capPerPosition.toUint96()); pool.timeRanges.push(next); } /** * @notice Removes the last Time Range for a given pool. * @param _poolId Available pool values 0-3 */ function removeLastTimeRange(uint256 _poolId) external onlyOwner { pools[_poolId].timeRanges.pop(); } /** * @notice Lookup method for a TimeRange struct * @return TimeRange A Pool's timeRanges struct by index. * @param _poolId Available pool values 0-3 * @param _index Target index in a Pool's timeRanges array */ function getTimeRangeBy(uint256 _poolId, uint256 _index) public view returns (TimeRange memory) { return pools[_poolId].timeRanges[_index]; } // Pool Methods /** * @notice Lookup available rewards for a pool over a given time range * @return uint256 The amount of ApeCoin rewards to be distributed by pool for a given time range * @return uint256 The amount of time ranges * @param _poolId Available pool values 0-3 * @param _from Whole hour timestamp representation * @param _to Whole hour timestamp representation */ function rewardsBy(uint256 _poolId, uint256 _from, uint256 _to) public view returns (uint256, uint256) { Pool memory pool = pools[_poolId]; uint256 currentIndex = pool.lastRewardsRangeIndex; if(_to < pool.timeRanges[0].startTimestampHour) return (0, currentIndex); while(_from > pool.timeRanges[currentIndex].endTimestampHour && _to > pool.timeRanges[currentIndex].endTimestampHour) { unchecked { ++currentIndex; } } uint256 rewards; TimeRange memory current; uint256 startTimestampHour; uint256 endTimestampHour; uint256 length = pool.timeRanges.length; for(uint256 i = currentIndex; i < length;) { current = pool.timeRanges[i]; startTimestampHour = _from <= current.startTimestampHour ? current.startTimestampHour : _from; endTimestampHour = _to <= current.endTimestampHour ? _to : current.endTimestampHour; rewards = rewards + (endTimestampHour - startTimestampHour) * current.rewardsPerHour / SECONDS_PER_HOUR; if(_to <= endTimestampHour) { return (rewards, i); } unchecked { ++i; } } return (rewards, length - 1); } /** * @notice Updates reward variables `lastRewardedTimestampHour`, `accumulatedRewardsPerShare` and `lastRewardsRangeIndex` * for a given pool. * @param _poolId Available pool values 0-3 */ function updatePool(uint256 _poolId) public { Pool storage pool = pools[_poolId]; if (block.timestamp < pool.timeRanges[0].startTimestampHour) return; if (block.timestamp <= pool.lastRewardedTimestampHour + SECONDS_PER_HOUR) return; uint48 lastTimestampHour = pool.timeRanges[pool.timeRanges.length-1].endTimestampHour; uint48 previousTimestampHour = getPreviousTimestampHour().toUint48(); if (pool.stakedAmount == 0) { pool.lastRewardedTimestampHour = previousTimestampHour > lastTimestampHour ? lastTimestampHour : previousTimestampHour; return; } (uint256 rewards, uint256 index) = rewardsBy(_poolId, pool.lastRewardedTimestampHour, previousTimestampHour); if (pool.lastRewardsRangeIndex != index) { pool.lastRewardsRangeIndex = index.toUint16(); } pool.accumulatedRewardsPerShare = (pool.accumulatedRewardsPerShare + (rewards * APE_COIN_PRECISION) / pool.stakedAmount).toUint96(); pool.lastRewardedTimestampHour = previousTimestampHour > lastTimestampHour ? lastTimestampHour : previousTimestampHour; emit UpdatePool(_poolId, pool.lastRewardedTimestampHour, pool.stakedAmount, pool.accumulatedRewardsPerShare); } // Read Methods function getCurrentTimeRangeIndex(Pool memory pool) private view returns (uint256) { uint256 current = pool.lastRewardsRangeIndex; if (block.timestamp < pool.timeRanges[current].startTimestampHour) return current; for(current = pool.lastRewardsRangeIndex; current < pool.timeRanges.length; ++current) { TimeRange memory currentTimeRange = pool.timeRanges[current]; if (currentTimeRange.startTimestampHour <= block.timestamp && block.timestamp <= currentTimeRange.endTimestampHour) return current; } revert("distribution ended"); } /** * @notice Fetches a PoolUI struct (poolId, stakedAmount, currentTimeRange) for each reward pool * @return PoolUI for ApeCoin. * @return PoolUI for BAYC. * @return PoolUI for MAYC. * @return PoolUI for BAKC. */ function getPoolsUI() public view returns (PoolUI memory, PoolUI memory, PoolUI memory, PoolUI memory) { Pool memory apeCoinPool = pools[0]; Pool memory baycPool = pools[1]; Pool memory maycPool = pools[2]; Pool memory bakcPool = pools[3]; uint256 current = getCurrentTimeRangeIndex(apeCoinPool); return (PoolUI(0,apeCoinPool.stakedAmount, apeCoinPool.timeRanges[current]), PoolUI(1,baycPool.stakedAmount, baycPool.timeRanges[current]), PoolUI(2,maycPool.stakedAmount, maycPool.timeRanges[current]), PoolUI(3,bakcPool.stakedAmount, bakcPool.timeRanges[current])); } /** * @notice Fetches an address total staked amount, used by voting contract * @return amount uint256 staked amount for all pools. * @param _address An Ethereum address */ function stakedTotal(address _address) external view returns (uint256) { uint256 total = addressPosition[_address].stakedAmount; total += _stakedTotal(BAYC_POOL_ID, _address); total += _stakedTotal(MAYC_POOL_ID, _address); total += _stakedTotalPair(_address); return total; } function _stakedTotal(uint256 _poolId, address _addr) private view returns (uint256) { uint256 total = 0; uint256 nftCount = nftContracts[_poolId].balanceOf(_addr); for(uint256 i = 0; i < nftCount; ++i) { uint256 tokenId = nftContracts[_poolId].tokenOfOwnerByIndex(_addr, i); total += nftPosition[_poolId][tokenId].stakedAmount; } return total; } function _stakedTotalPair(address _addr) private view returns (uint256) { uint256 total = 0; uint256 nftCount = nftContracts[BAYC_POOL_ID].balanceOf(_addr); for(uint256 i = 0; i < nftCount; ++i) { uint256 baycTokenId = nftContracts[BAYC_POOL_ID].tokenOfOwnerByIndex(_addr, i); if (mainToBakc[BAYC_POOL_ID][baycTokenId].isPaired) { uint256 bakcTokenId = mainToBakc[BAYC_POOL_ID][baycTokenId].tokenId; total += nftPosition[BAKC_POOL_ID][bakcTokenId].stakedAmount; } } nftCount = nftContracts[MAYC_POOL_ID].balanceOf(_addr); for(uint256 i = 0; i < nftCount; ++i) { uint256 maycTokenId = nftContracts[MAYC_POOL_ID].tokenOfOwnerByIndex(_addr, i); if (mainToBakc[MAYC_POOL_ID][maycTokenId].isPaired) { uint256 bakcTokenId = mainToBakc[MAYC_POOL_ID][maycTokenId].tokenId; total += nftPosition[BAKC_POOL_ID][bakcTokenId].stakedAmount; } } return total; } /** * @notice Fetches a DashboardStake = [poolId, tokenId, deposited, unclaimed, rewards24Hrs, paired] \ * for each pool, for an Ethereum address * @return dashboardStakes An array of DashboardStake structs * @param _address An Ethereum address */ function getAllStakes(address _address) public view returns (DashboardStake[] memory) { DashboardStake memory apeCoinStake = getApeCoinStake(_address); DashboardStake[] memory baycStakes = getBaycStakes(_address); DashboardStake[] memory maycStakes = getMaycStakes(_address); DashboardStake[] memory bakcStakes = getBakcStakes(_address); DashboardStake[] memory splitStakes = getSplitStakes(_address); uint256 count = (baycStakes.length + maycStakes.length + bakcStakes.length + splitStakes.length + 1); DashboardStake[] memory allStakes = new DashboardStake[](count); uint256 offset = 0; allStakes[offset] = apeCoinStake; ++offset; for(uint256 i = 0; i < baycStakes.length; ++i) { allStakes[offset] = baycStakes[i]; ++offset; } for(uint256 i = 0; i < maycStakes.length; ++i) { allStakes[offset] = maycStakes[i]; ++offset; } for(uint256 i = 0; i < bakcStakes.length; ++i) { allStakes[offset] = bakcStakes[i]; ++offset; } for(uint256 i = 0; i < splitStakes.length; ++i) { allStakes[offset] = splitStakes[i]; ++offset; } return allStakes; } /** * @notice Fetches a DashboardStake for the ApeCoin pool * @return dashboardStake A dashboardStake struct * @param _address An Ethereum address */ function getApeCoinStake(address _address) public view returns (DashboardStake memory) { uint256 tokenId = 0; uint256 deposited = addressPosition[_address].stakedAmount; uint256 unclaimed = deposited > 0 ? this.pendingRewards(0, _address, tokenId) : 0; uint256 rewards24Hrs = deposited > 0 ? _estimate24HourRewards(0, _address, 0) : 0; return DashboardStake(APECOIN_POOL_ID, tokenId, deposited, unclaimed, rewards24Hrs, NULL_PAIR); } /** * @notice Fetches an array of DashboardStakes for the BAYC pool * @return dashboardStakes An array of DashboardStake structs */ function getBaycStakes(address _address) public view returns (DashboardStake[] memory) { return _getStakes(_address, BAYC_POOL_ID); } /** * @notice Fetches an array of DashboardStakes for the MAYC pool * @return dashboardStakes An array of DashboardStake structs */ function getMaycStakes(address _address) public view returns (DashboardStake[] memory) { return _getStakes(_address, MAYC_POOL_ID); } /** * @notice Fetches an array of DashboardStakes for the BAKC pool * @return dashboardStakes An array of DashboardStake structs */ function getBakcStakes(address _address) public view returns (DashboardStake[] memory) { return _getStakes(_address, BAKC_POOL_ID); } /** * @notice Fetches an array of DashboardStakes for the Pair Pool when ownership is split \ * ie (BAYC/MAYC) and BAKC in pair pool have different owners. * @return dashboardStakes An array of DashboardStake structs * @param _address An Ethereum address */ function getSplitStakes(address _address) public view returns (DashboardStake[] memory) { uint256 baycSplits = _getSplitStakeCount(nftContracts[BAYC_POOL_ID].balanceOf(_address), _address, BAYC_POOL_ID); uint256 maycSplits = _getSplitStakeCount(nftContracts[MAYC_POOL_ID].balanceOf(_address), _address, MAYC_POOL_ID); uint256 totalSplits = baycSplits + maycSplits; if(totalSplits == 0) { return new DashboardStake[](0); } DashboardStake[] memory baycSplitStakes = _getSplitStakes(baycSplits, _address, BAYC_POOL_ID); DashboardStake[] memory maycSplitStakes = _getSplitStakes(maycSplits, _address, MAYC_POOL_ID); DashboardStake[] memory splitStakes = new DashboardStake[](totalSplits); uint256 offset = 0; for(uint256 i = 0; i < baycSplitStakes.length; ++i) { splitStakes[offset] = baycSplitStakes[i]; ++offset; } for(uint256 i = 0; i < maycSplitStakes.length; ++i) { splitStakes[offset] = maycSplitStakes[i]; ++offset; } return splitStakes; } function _getSplitStakes(uint256 splits, address _address, uint256 _mainPoolId) private view returns (DashboardStake[] memory) { DashboardStake[] memory dashboardStakes = new DashboardStake[](splits); uint256 counter; for(uint256 i = 0; i < nftContracts[_mainPoolId].balanceOf(_address); ++i) { uint256 mainTokenId = nftContracts[_mainPoolId].tokenOfOwnerByIndex(_address, i); if(mainToBakc[_mainPoolId][mainTokenId].isPaired) { uint256 bakcTokenId = mainToBakc[_mainPoolId][mainTokenId].tokenId; address currentOwner = nftContracts[BAKC_POOL_ID].ownerOf(bakcTokenId); /* Split Pair Check*/ if (currentOwner != _address) { uint256 deposited = nftPosition[BAKC_POOL_ID][bakcTokenId].stakedAmount; uint256 unclaimed = deposited > 0 ? this.pendingRewards(BAKC_POOL_ID, currentOwner, bakcTokenId) : 0; uint256 rewards24Hrs = deposited > 0 ? _estimate24HourRewards(BAKC_POOL_ID, currentOwner, bakcTokenId): 0; DashboardPair memory pair = NULL_PAIR; if(bakcToMain[bakcTokenId][_mainPoolId].isPaired) { pair = DashboardPair(bakcToMain[bakcTokenId][_mainPoolId].tokenId, _mainPoolId); } DashboardStake memory dashboardStake = DashboardStake(BAKC_POOL_ID, bakcTokenId, deposited, unclaimed, rewards24Hrs, pair); dashboardStakes[counter] = dashboardStake; ++counter; } } } return dashboardStakes; } function _getSplitStakeCount(uint256 nftCount, address _address, uint256 _mainPoolId) private view returns (uint256) { uint256 splitCount; for(uint256 i = 0; i < nftCount; ++i) { uint256 mainTokenId = nftContracts[_mainPoolId].tokenOfOwnerByIndex(_address, i); if(mainToBakc[_mainPoolId][mainTokenId].isPaired) { uint256 bakcTokenId = mainToBakc[_mainPoolId][mainTokenId].tokenId; address currentOwner = nftContracts[BAKC_POOL_ID].ownerOf(bakcTokenId); if (currentOwner != _address) { ++splitCount; } } } return splitCount; } function _getStakes(address _address, uint256 _poolId) private view returns (DashboardStake[] memory) { uint256 nftCount = nftContracts[_poolId].balanceOf(_address); DashboardStake[] memory dashboardStakes = nftCount > 0 ? new DashboardStake[](nftCount) : new DashboardStake[](0); if(nftCount == 0) { return dashboardStakes; } for(uint256 i = 0; i < nftCount; ++i) { uint256 tokenId = nftContracts[_poolId].tokenOfOwnerByIndex(_address, i); uint256 deposited = nftPosition[_poolId][tokenId].stakedAmount; uint256 unclaimed = deposited > 0 ? this.pendingRewards(_poolId, _address, tokenId) : 0; uint256 rewards24Hrs = deposited > 0 ? _estimate24HourRewards(_poolId, _address, tokenId): 0; DashboardPair memory pair = NULL_PAIR; if(_poolId == BAKC_POOL_ID) { if(bakcToMain[tokenId][BAYC_POOL_ID].isPaired) { pair = DashboardPair(bakcToMain[tokenId][BAYC_POOL_ID].tokenId, BAYC_POOL_ID); } else if(bakcToMain[tokenId][MAYC_POOL_ID].isPaired) { pair = DashboardPair(bakcToMain[tokenId][MAYC_POOL_ID].tokenId, MAYC_POOL_ID); } } DashboardStake memory dashboardStake = DashboardStake(_poolId, tokenId, deposited, unclaimed, rewards24Hrs, pair); dashboardStakes[i] = dashboardStake; } return dashboardStakes; } function _estimate24HourRewards(uint256 _poolId, address _address, uint256 _tokenId) private view returns (uint256) { Pool memory pool = pools[_poolId]; Position memory position = _poolId == 0 ? addressPosition[_address]: nftPosition[_poolId][_tokenId]; TimeRange memory rewards = getTimeRangeBy(_poolId, pool.lastRewardsRangeIndex); return (position.stakedAmount * uint256(rewards.rewardsPerHour) * 24) / uint256(pool.stakedAmount); } /** * @notice Fetches the current amount of claimable ApeCoin rewards for a given position from a given pool. * @return uint256 value of pending rewards * @param _poolId Available pool values 0-3 * @param _address Address to lookup Position for * @param _tokenId An NFT id */ function pendingRewards(uint256 _poolId, address _address, uint256 _tokenId) external view returns (uint256) { Pool memory pool = pools[_poolId]; Position memory position = _poolId == 0 ? addressPosition[_address]: nftPosition[_poolId][_tokenId]; (uint256 rewardsSinceLastCalculated,) = rewardsBy(_poolId, pool.lastRewardedTimestampHour, getPreviousTimestampHour()); uint256 accumulatedRewardsPerShare = pool.accumulatedRewardsPerShare; if (block.timestamp > pool.lastRewardedTimestampHour + SECONDS_PER_HOUR && pool.stakedAmount != 0) { accumulatedRewardsPerShare = accumulatedRewardsPerShare + rewardsSinceLastCalculated * APE_COIN_PRECISION / pool.stakedAmount; } return ((position.stakedAmount * accumulatedRewardsPerShare).toInt256() - position.rewardsDebt).toUint256() / APE_COIN_PRECISION; } // Convenience methods for timestamp calculation /// @notice the minutes (0 to 59) of a timestamp function getMinute(uint256 timestamp) internal pure returns (uint256 minute) { uint256 secs = timestamp % SECONDS_PER_HOUR; minute = secs / SECONDS_PER_MINUTE; } /// @notice the seconds (0 to 59) of a timestamp function getSecond(uint256 timestamp) internal pure returns (uint256 second) { second = timestamp % SECONDS_PER_MINUTE; } /// @notice the previous whole hour of a timestamp function getPreviousTimestampHour() internal view returns (uint256) { return block.timestamp - (getMinute(block.timestamp) * 60 + getSecond(block.timestamp)); } // Private Methods - shared logic function _deposit(uint256 _poolId, Position storage _position, uint256 _amount) private { Pool storage pool = pools[_poolId]; _position.stakedAmount += _amount; pool.stakedAmount += _amount.toUint96(); _position.rewardsDebt += (_amount * pool.accumulatedRewardsPerShare).toInt256(); } function _depositNft(uint256 _poolId, SingleNft[] calldata _nfts) private { updatePool(_poolId); uint256 tokenId; uint256 amount; Position storage position; uint256 length = _nfts.length; uint256 totalDeposit; for(uint256 i; i < length;) { tokenId = _nfts[i].tokenId; position = nftPosition[_poolId][tokenId]; if (position.stakedAmount == 0) { if (nftContracts[_poolId].ownerOf(tokenId) != msg.sender) revert CallerNotOwner(); } amount = _nfts[i].amount; _depositNftGuard(_poolId, position, amount); totalDeposit += amount; emit DepositNft(msg.sender, _poolId, amount, tokenId); unchecked { ++i; } } if (totalDeposit > 0) apeCoin.transferFrom(msg.sender, address(this), totalDeposit); } function _depositPairNft(uint256 mainTypePoolId, PairNftDepositWithAmount[] calldata _nfts) private { uint256 length = _nfts.length; uint256 totalDeposit; PairNftDepositWithAmount memory pair; Position storage position; for(uint256 i; i < length;) { pair = _nfts[i]; position = nftPosition[BAKC_POOL_ID][pair.bakcTokenId]; if(position.stakedAmount == 0) { if (nftContracts[mainTypePoolId].ownerOf(pair.mainTokenId) != msg.sender || mainToBakc[mainTypePoolId][pair.mainTokenId].isPaired) revert MainTokenNotOwnedOrPaired(); if (nftContracts[BAKC_POOL_ID].ownerOf(pair.bakcTokenId) != msg.sender || bakcToMain[pair.bakcTokenId][mainTypePoolId].isPaired) revert BAKCNotOwnedOrPaired(); mainToBakc[mainTypePoolId][pair.mainTokenId] = PairingStatus(pair.bakcTokenId, true); bakcToMain[pair.bakcTokenId][mainTypePoolId] = PairingStatus(pair.mainTokenId, true); } else if (pair.mainTokenId != bakcToMain[pair.bakcTokenId][mainTypePoolId].tokenId || pair.bakcTokenId != mainToBakc[mainTypePoolId][pair.mainTokenId].tokenId) revert BAKCAlreadyPaired(); _depositNftGuard(BAKC_POOL_ID, position, pair.amount); totalDeposit += pair.amount; emit DepositPairNft(msg.sender, pair.amount, mainTypePoolId, pair.mainTokenId, pair.bakcTokenId); unchecked { ++i; } } if (totalDeposit > 0) apeCoin.transferFrom(msg.sender, address(this), totalDeposit); } function _depositNftGuard(uint256 _poolId, Position storage _position, uint256 _amount) private { if (_amount < MIN_DEPOSIT) revert DepositMoreThanOneAPE(); if (_amount + _position.stakedAmount > pools[_poolId].timeRanges[pools[_poolId].lastRewardsRangeIndex].capPerPosition) revert ExceededCapAmount(); _deposit(_poolId, _position, _amount); } function _claim(uint256 _poolId, Position storage _position, address _recipient) private returns (uint256 rewardsToBeClaimed) { Pool storage pool = pools[_poolId]; int256 accumulatedApeCoins = (_position.stakedAmount * uint256(pool.accumulatedRewardsPerShare)).toInt256(); rewardsToBeClaimed = (accumulatedApeCoins - _position.rewardsDebt).toUint256() / APE_COIN_PRECISION; _position.rewardsDebt = accumulatedApeCoins; if (rewardsToBeClaimed != 0) { apeCoin.transfer(_recipient, rewardsToBeClaimed); } } function _claimNft(uint256 _poolId, uint256[] calldata _nfts, address _recipient) private { updatePool(_poolId); uint256 tokenId; uint256 rewardsToBeClaimed; uint256 length = _nfts.length; for(uint256 i; i < length;) { tokenId = _nfts[i]; if (nftContracts[_poolId].ownerOf(tokenId) != msg.sender) revert CallerNotOwner(); Position storage position = nftPosition[_poolId][tokenId]; rewardsToBeClaimed = _claim(_poolId, position, _recipient); emit ClaimRewardsNft(msg.sender, _poolId, rewardsToBeClaimed, tokenId); unchecked { ++i; } } } function _claimPairNft(uint256 mainTypePoolId, PairNft[] calldata _pairs, address _recipient) private { uint256 length = _pairs.length; uint256 mainTokenId; uint256 bakcTokenId; Position storage position; PairingStatus storage mainToSecond; PairingStatus storage secondToMain; for(uint256 i; i < length;) { mainTokenId = _pairs[i].mainTokenId; if (nftContracts[mainTypePoolId].ownerOf(mainTokenId) != msg.sender) revert NotOwnerOfMain(); bakcTokenId = _pairs[i].bakcTokenId; if (nftContracts[BAKC_POOL_ID].ownerOf(bakcTokenId) != msg.sender) revert NotOwnerOfBAKC(); mainToSecond = mainToBakc[mainTypePoolId][mainTokenId]; secondToMain = bakcToMain[bakcTokenId][mainTypePoolId]; if (mainToSecond.tokenId != bakcTokenId || !mainToSecond.isPaired || secondToMain.tokenId != mainTokenId || !secondToMain.isPaired) revert ProvidedTokensNotPaired(); position = nftPosition[BAKC_POOL_ID][bakcTokenId]; uint256 rewardsToBeClaimed = _claim(BAKC_POOL_ID, position, _recipient); emit ClaimRewardsPairNft(msg.sender, rewardsToBeClaimed, mainTypePoolId, mainTokenId, bakcTokenId); unchecked { ++i; } } } function _withdraw(uint256 _poolId, Position storage _position, uint256 _amount) private { if (_amount > _position.stakedAmount) revert ExceededStakedAmount(); Pool storage pool = pools[_poolId]; _position.stakedAmount -= _amount; pool.stakedAmount -= _amount.toUint96(); _position.rewardsDebt -= (_amount * pool.accumulatedRewardsPerShare).toInt256(); } function _withdrawNft(uint256 _poolId, SingleNft[] calldata _nfts, address _recipient) private { updatePool(_poolId); uint256 tokenId; uint256 amount; uint256 length = _nfts.length; uint256 totalWithdraw; Position storage position; for(uint256 i; i < length;) { tokenId = _nfts[i].tokenId; if (nftContracts[_poolId].ownerOf(tokenId) != msg.sender) revert CallerNotOwner(); amount = _nfts[i].amount; position = nftPosition[_poolId][tokenId]; if (amount == position.stakedAmount) { uint256 rewardsToBeClaimed = _claim(_poolId, position, _recipient); emit ClaimRewardsNft(msg.sender, _poolId, rewardsToBeClaimed, tokenId); } _withdraw(_poolId, position, amount); totalWithdraw += amount; emit WithdrawNft(msg.sender, _poolId, amount, _recipient, tokenId); unchecked { ++i; } } if (totalWithdraw > 0) apeCoin.transfer(_recipient, totalWithdraw); } function _withdrawPairNft(uint256 mainTypePoolId, PairNftWithdrawWithAmount[] calldata _nfts) private { address mainTokenOwner; address bakcOwner; PairNftWithdrawWithAmount memory pair; PairingStatus storage mainToSecond; PairingStatus storage secondToMain; Position storage position; uint256 length = _nfts.length; for(uint256 i; i < length;) { pair = _nfts[i]; mainTokenOwner = nftContracts[mainTypePoolId].ownerOf(pair.mainTokenId); bakcOwner = nftContracts[BAKC_POOL_ID].ownerOf(pair.bakcTokenId); if (mainTokenOwner != msg.sender) { if (bakcOwner != msg.sender) revert NeitherTokenInPairOwnedByCaller(); } mainToSecond = mainToBakc[mainTypePoolId][pair.mainTokenId]; secondToMain = bakcToMain[pair.bakcTokenId][mainTypePoolId]; if (mainToSecond.tokenId != pair.bakcTokenId || !mainToSecond.isPaired || secondToMain.tokenId != pair.mainTokenId || !secondToMain.isPaired) revert ProvidedTokensNotPaired(); position = nftPosition[BAKC_POOL_ID][pair.bakcTokenId]; if(!pair.isUncommit) { if(pair.amount == position.stakedAmount) revert UncommitWrongParameters(); } if (mainTokenOwner != bakcOwner) { if (!pair.isUncommit) revert SplitPairCantPartiallyWithdraw(); } if (pair.isUncommit) { uint256 rewardsToBeClaimed = _claim(BAKC_POOL_ID, position, bakcOwner); mainToBakc[mainTypePoolId][pair.mainTokenId] = PairingStatus(0, false); bakcToMain[pair.bakcTokenId][mainTypePoolId] = PairingStatus(0, false); emit ClaimRewardsPairNft(msg.sender, rewardsToBeClaimed, mainTypePoolId, pair.mainTokenId, pair.bakcTokenId); } uint256 finalAmountToWithdraw = pair.isUncommit ? position.stakedAmount: pair.amount; _withdraw(BAKC_POOL_ID, position, finalAmountToWithdraw); apeCoin.transfer(mainTokenOwner, finalAmountToWithdraw); emit WithdrawPairNft(msg.sender, finalAmountToWithdraw, mainTypePoolId, pair.mainTokenId, pair.bakcTokenId); unchecked { ++i; } } } }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {IPoolAddressesProvider} from "./IPoolAddressesProvider.sol"; /** * @title IACLManager * * @notice Defines the basic interface for the ACL Manager **/ interface IACLManager { /** * @notice Returns the contract address of the PoolAddressesProvider * @return The address of the PoolAddressesProvider */ function ADDRESSES_PROVIDER() external view returns (IPoolAddressesProvider); /** * @notice Returns the identifier of the PoolAdmin role * @return The id of the PoolAdmin role */ function POOL_ADMIN_ROLE() external view returns (bytes32); /** * @notice Returns the identifier of the EmergencyAdmin role * @return The id of the EmergencyAdmin role */ function EMERGENCY_ADMIN_ROLE() external view returns (bytes32); /** * @notice Returns the identifier of the RiskAdmin role * @return The id of the RiskAdmin role */ function RISK_ADMIN_ROLE() external view returns (bytes32); /** * @notice Returns the identifier of the FlashBorrower role * @return The id of the FlashBorrower role */ function FLASH_BORROWER_ROLE() external view returns (bytes32); /** * @notice Returns the identifier of the Bridge role * @return The id of the Bridge role */ function BRIDGE_ROLE() external view returns (bytes32); /** * @notice Returns the identifier of the AssetListingAdmin role * @return The id of the AssetListingAdmin role */ function ASSET_LISTING_ADMIN_ROLE() external view returns (bytes32); /** * @notice Set the role as admin of a specific role. * @dev By default the admin role for all roles is `DEFAULT_ADMIN_ROLE`. * @param role The role to be managed by the admin role * @param adminRole The admin role */ function setRoleAdmin(bytes32 role, bytes32 adminRole) external; /** * @notice Adds a new admin as PoolAdmin * @param admin The address of the new admin */ function addPoolAdmin(address admin) external; /** * @notice Removes an admin as PoolAdmin * @param admin The address of the admin to remove */ function removePoolAdmin(address admin) external; /** * @notice Returns true if the address is PoolAdmin, false otherwise * @param admin The address to check * @return True if the given address is PoolAdmin, false otherwise */ function isPoolAdmin(address admin) external view returns (bool); /** * @notice Adds a new admin as EmergencyAdmin * @param admin The address of the new admin */ function addEmergencyAdmin(address admin) external; /** * @notice Removes an admin as EmergencyAdmin * @param admin The address of the admin to remove */ function removeEmergencyAdmin(address admin) external; /** * @notice Returns true if the address is EmergencyAdmin, false otherwise * @param admin The address to check * @return True if the given address is EmergencyAdmin, false otherwise */ function isEmergencyAdmin(address admin) external view returns (bool); /** * @notice Adds a new admin as RiskAdmin * @param admin The address of the new admin */ function addRiskAdmin(address admin) external; /** * @notice Removes an admin as RiskAdmin * @param admin The address of the admin to remove */ function removeRiskAdmin(address admin) external; /** * @notice Returns true if the address is RiskAdmin, false otherwise * @param admin The address to check * @return True if the given address is RiskAdmin, false otherwise */ function isRiskAdmin(address admin) external view returns (bool); /** * @notice Adds a new address as FlashBorrower * @param borrower The address of the new FlashBorrower */ function addFlashBorrower(address borrower) external; /** * @notice Removes an admin as FlashBorrower * @param borrower The address of the FlashBorrower to remove */ function removeFlashBorrower(address borrower) external; /** * @notice Returns true if the address is FlashBorrower, false otherwise * @param borrower The address to check * @return True if the given address is FlashBorrower, false otherwise */ function isFlashBorrower(address borrower) external view returns (bool); /** * @notice Adds a new address as Bridge * @param bridge The address of the new Bridge */ function addBridge(address bridge) external; /** * @notice Removes an address as Bridge * @param bridge The address of the bridge to remove */ function removeBridge(address bridge) external; /** * @notice Returns true if the address is Bridge, false otherwise * @param bridge The address to check * @return True if the given address is Bridge, false otherwise */ function isBridge(address bridge) external view returns (bool); /** * @notice Adds a new admin as AssetListingAdmin * @param admin The address of the new admin */ function addAssetListingAdmin(address admin) external; /** * @notice Removes an admin as AssetListingAdmin * @param admin The address of the admin to remove */ function removeAssetListingAdmin(address admin) external; /** * @notice Returns true if the address is AssetListingAdmin, false otherwise * @param admin The address to check * @return True if the given address is AssetListingAdmin, false otherwise */ function isAssetListingAdmin(address admin) external view returns (bool); }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; /** * @title IAtomicCollateralizableERC721 * @author Parallel * @notice Defines the basic interface for an AtomicCollateralizableERC721. **/ interface IAtomicCollateralizableERC721 { /** * @dev check if specific token has atomic pricing (has atomic oracle wrapper) */ function isAtomicPricing() external view returns (bool); /** * @dev get the avg trait multiplier of collateralized tokens */ function avgMultiplierOf(address user) external view returns (uint256); /** * @dev get the trait multiplier of specific NFT */ function getTraitMultiplier(uint256 tokenId) external view returns (uint256); }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; /******************************************************************************\ * EIP-2535: https://eips.ethereum.org/EIPS/eip-2535 /******************************************************************************/ interface IParaProxy { enum ProxyImplementationAction { Add, Replace, Remove } // Add=0, Replace=1, Remove=2 struct ProxyImplementation { address implAddress; ProxyImplementationAction action; bytes4[] functionSelectors; } /// @notice Add/replace/remove any number of functions and optionally execute /// a function with delegatecall /// @param _implementationParams Contains the implementation addresses and function selectors /// @param _init The address of the contract or implementation to execute _calldata /// @param _calldata A function call, including function selector and arguments /// _calldata is executed with delegatecall on _init function updateImplementation( ProxyImplementation[] calldata _implementationParams, address _init, bytes calldata _calldata ) external; event ImplementationUpdated( ProxyImplementation[] _implementationParams, address _init, bytes _calldata ); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /******************************************************************************\ * EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 /******************************************************************************/ // interfaces that are compatible with Diamond proxy loupe functions interface IParaProxyInterfaces { /// These functions are expected to be called frequently /// by tools. struct Implementation { address implAddress; bytes4[] functionSelectors; } /// @notice Gets all facet addresses and their four byte function selectors. /// @return facets_ Implementation function facets() external view returns (Implementation[] memory facets_); /// @notice Gets all the function selectors supported by a specific facet. /// @param _facet The facet address. /// @return facetFunctionSelectors_ function facetFunctionSelectors(address _facet) external view returns (bytes4[] memory facetFunctionSelectors_); /// @notice Get all the facet addresses used by a diamond. /// @return facetAddresses_ function facetAddresses() external view returns (address[] memory facetAddresses_); /// @notice Gets the facet that supports the given selector. /// @dev If facet is not found return address(0). /// @param _functionSelector The function selector. /// @return facetAddress_ The facet address. function facetAddress(bytes4 _functionSelector) external view returns (address facetAddress_); }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {IPoolCore} from "./IPoolCore.sol"; import {IPoolMarketplace} from "./IPoolMarketplace.sol"; import {IPoolParameters} from "./IPoolParameters.sol"; import {IParaProxyInterfaces} from "./IParaProxyInterfaces.sol"; import {IPoolPositionMover} from "./IPoolPositionMover.sol"; import "./IPoolApeStaking.sol"; /** * @title IPool * * @notice Defines the basic interface for an ParaSpace Pool. **/ interface IPool is IPoolCore, IPoolMarketplace, IPoolParameters, IPoolApeStaking, IParaProxyInterfaces, IPoolPositionMover { }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {DataTypes} from "../protocol/libraries/types/DataTypes.sol"; import {IParaProxy} from "../interfaces/IParaProxy.sol"; /** * @title IPoolAddressesProvider * * @notice Defines the basic interface for a Pool Addresses Provider. **/ interface IPoolAddressesProvider { /** * @dev Emitted when the market identifier is updated. * @param oldMarketId The old id of the market * @param newMarketId The new id of the market */ event MarketIdSet(string indexed oldMarketId, string indexed newMarketId); /** * @dev Emitted when the pool is updated. * @param implementationParams The old address of the Pool * @param _init The new address to call upon upgrade * @param _calldata The calldata input for the call */ event PoolUpdated( IParaProxy.ProxyImplementation[] indexed implementationParams, address _init, bytes _calldata ); /** * @dev Emitted when the pool configurator is updated. * @param oldAddress The old address of the PoolConfigurator * @param newAddress The new address of the PoolConfigurator */ event PoolConfiguratorUpdated( address indexed oldAddress, address indexed newAddress ); /** * @dev Emitted when the WETH is updated. * @param oldAddress The old address of the WETH * @param newAddress The new address of the WETH */ event WETHUpdated(address indexed oldAddress, address indexed newAddress); /** * @dev Emitted when the price oracle is updated. * @param oldAddress The old address of the PriceOracle * @param newAddress The new address of the PriceOracle */ event PriceOracleUpdated( address indexed oldAddress, address indexed newAddress ); /** * @dev Emitted when the ACL manager is updated. * @param oldAddress The old address of the ACLManager * @param newAddress The new address of the ACLManager */ event ACLManagerUpdated( address indexed oldAddress, address indexed newAddress ); /** * @dev Emitted when the ACL admin is updated. * @param oldAddress The old address of the ACLAdmin * @param newAddress The new address of the ACLAdmin */ event ACLAdminUpdated( address indexed oldAddress, address indexed newAddress ); /** * @dev Emitted when the price oracle sentinel is updated. * @param oldAddress The old address of the PriceOracleSentinel * @param newAddress The new address of the PriceOracleSentinel */ event PriceOracleSentinelUpdated( address indexed oldAddress, address indexed newAddress ); /** * @dev Emitted when the pool data provider is updated. * @param oldAddress The old address of the PoolDataProvider * @param newAddress The new address of the PoolDataProvider */ event ProtocolDataProviderUpdated( address indexed oldAddress, address indexed newAddress ); /** * @dev Emitted when a new proxy is created. * @param id The identifier of the proxy * @param proxyAddress The address of the created proxy contract * @param implementationAddress The address of the implementation contract */ event ProxyCreated( bytes32 indexed id, address indexed proxyAddress, address indexed implementationAddress ); /** * @dev Emitted when a new proxy is created. * @param id The identifier of the proxy * @param proxyAddress The address of the created proxy contract * @param implementationParams The params of the implementation update */ event ParaProxyCreated( bytes32 indexed id, address indexed proxyAddress, IParaProxy.ProxyImplementation[] indexed implementationParams ); /** * @dev Emitted when a new proxy is created. * @param id The identifier of the proxy * @param proxyAddress The address of the created proxy contract * @param implementationParams The params of the implementation update */ event ParaProxyUpdated( bytes32 indexed id, address indexed proxyAddress, IParaProxy.ProxyImplementation[] indexed implementationParams ); /** * @dev Emitted when a new non-proxied contract address is registered. * @param id The identifier of the contract * @param oldAddress The address of the old contract * @param newAddress The address of the new contract */ event AddressSet( bytes32 indexed id, address indexed oldAddress, address indexed newAddress ); /** * @dev Emitted when the implementation of the proxy registered with id is updated * @param id The identifier of the contract * @param proxyAddress The address of the proxy contract * @param oldImplementationAddress The address of the old implementation contract * @param newImplementationAddress The address of the new implementation contract */ event AddressSetAsProxy( bytes32 indexed id, address indexed proxyAddress, address oldImplementationAddress, address indexed newImplementationAddress ); /** * @dev Emitted when the marketplace registered is updated * @param id The identifier of the marketplace * @param marketplace The address of the marketplace contract * @param adapter The address of the marketplace adapter contract * @param operator The address of the marketplace transfer helper * @param paused Is the marketplace adapter paused */ event MarketplaceUpdated( bytes32 indexed id, address indexed marketplace, address indexed adapter, address operator, bool paused ); /** * @notice Returns the id of the ParaSpace market to which this contract points to. * @return The market id **/ function getMarketId() external view returns (string memory); /** * @notice Associates an id with a specific PoolAddressesProvider. * @dev This can be used to create an onchain registry of PoolAddressesProviders to * identify and validate multiple ParaSpace markets. * @param newMarketId The market id */ function setMarketId(string calldata newMarketId) external; /** * @notice Returns an address by its identifier. * @dev The returned address might be an EOA or a contract, potentially proxied * @dev It returns ZERO if there is no registered address with the given id * @param id The id * @return The address of the registered for the specified id */ function getAddress(bytes32 id) external view returns (address); /** * @notice General function to update the implementation of a proxy registered with * certain `id`. If there is no proxy registered, it will instantiate one and * set as implementation the `newImplementationAddress`. * @dev IMPORTANT Use this function carefully, only for ids that don't have an explicit * setter function, in order to avoid unexpected consequences * @param id The id * @param newImplementationAddress The address of the new implementation */ function setAddressAsProxy(bytes32 id, address newImplementationAddress) external; /** * @notice Sets an address for an id replacing the address saved in the addresses map. * @dev IMPORTANT Use this function carefully, as it will do a hard replacement * @param id The id * @param newAddress The address to set */ function setAddress(bytes32 id, address newAddress) external; /** * @notice Returns the address of the Pool proxy. * @return The Pool proxy address **/ function getPool() external view returns (address); /** * @notice Updates the implementation of the Pool, or creates a proxy * setting the new `pool` implementation when the function is called for the first time. * @param implementationParams Contains the implementation addresses and function selectors * @param _init The address of the contract or implementation to execute _calldata * @param _calldata A function call, including function selector and arguments * _calldata is executed with delegatecall on _init **/ function updatePoolImpl( IParaProxy.ProxyImplementation[] calldata implementationParams, address _init, bytes calldata _calldata ) external; /** * @notice Returns the address of the PoolConfigurator proxy. * @return The PoolConfigurator proxy address **/ function getPoolConfigurator() external view returns (address); /** * @notice Updates the implementation of the PoolConfigurator, or creates a proxy * setting the new `PoolConfigurator` implementation when the function is called for the first time. * @param newPoolConfiguratorImpl The new PoolConfigurator implementation **/ function setPoolConfiguratorImpl(address newPoolConfiguratorImpl) external; /** * @notice Returns the address of the price oracle. * @return The address of the PriceOracle */ function getPriceOracle() external view returns (address); /** * @notice Updates the address of the price oracle. * @param newPriceOracle The address of the new PriceOracle */ function setPriceOracle(address newPriceOracle) external; /** * @notice Returns the address of the ACL manager. * @return The address of the ACLManager */ function getACLManager() external view returns (address); /** * @notice Updates the address of the ACL manager. * @param newAclManager The address of the new ACLManager **/ function setACLManager(address newAclManager) external; /** * @notice Returns the address of the ACL admin. * @return The address of the ACL admin */ function getACLAdmin() external view returns (address); /** * @notice Updates the address of the ACL admin. * @param newAclAdmin The address of the new ACL admin */ function setACLAdmin(address newAclAdmin) external; /** * @notice Returns the address of the price oracle sentinel. * @return The address of the PriceOracleSentinel */ function getPriceOracleSentinel() external view returns (address); /** * @notice Updates the address of the price oracle sentinel. * @param newPriceOracleSentinel The address of the new PriceOracleSentinel **/ function setPriceOracleSentinel(address newPriceOracleSentinel) external; /** * @notice Returns the address of the data provider. * @return The address of the DataProvider */ function getPoolDataProvider() external view returns (address); /** * @notice Returns the address of the Wrapped ETH. * @return The address of the Wrapped ETH */ function getWETH() external view returns (address); /** * @notice Returns the info of the marketplace. * @return The info of the marketplace */ function getMarketplace(bytes32 id) external view returns (DataTypes.Marketplace memory); /** * @notice Updates the address of the data provider. * @param newDataProvider The address of the new DataProvider **/ function setProtocolDataProvider(address newDataProvider) external; /** * @notice Updates the address of the WETH. * @param newWETH The address of the new WETH **/ function setWETH(address newWETH) external; /** * @notice Updates the info of the marketplace. * @param marketplace The address of the marketplace * @param adapter The contract which handles marketplace logic * @param operator The contract which operates users' tokens **/ function setMarketplace( bytes32 id, address marketplace, address adapter, address operator, bool paused ) external; }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import "../dependencies/yoga-labs/ApeCoinStaking.sol"; /** * @title IPoolApeStaking * * @notice Defines the basic interface for an ParaSpace Ape Staking Pool. **/ interface IPoolApeStaking { struct StakingInfo { // Contract address of BAYC/MAYC address nftAsset; // address of borrowing asset, can be Ape or cApe address borrowAsset; // Borrow amount of Ape from lending pool uint256 borrowAmount; // Cash amount of Ape from user wallet uint256 cashAmount; } /** * @notice Deposit ape coin to BAYC/MAYC pool or BAKC pool * @param stakingInfo Detail info of the staking * @param _nfts Array of BAYC/MAYC NFT's with staked amounts * @param _nftPairs Array of Paired BAYC/MAYC NFT's with staked amounts * @dev Need check User health factor > 1. */ function borrowApeAndStake( StakingInfo calldata stakingInfo, ApeCoinStaking.SingleNft[] calldata _nfts, ApeCoinStaking.PairNftDepositWithAmount[] calldata _nftPairs ) external; /** * @notice Withdraw staked ApeCoin from the BAYC/MAYC pool * @param nftAsset Contract address of BAYC/MAYC * @param _nfts Array of BAYC/MAYC NFT's with staked amounts * @dev Need check User health factor > 1. */ function withdrawApeCoin( address nftAsset, ApeCoinStaking.SingleNft[] calldata _nfts ) external; /** * @notice Claim rewards for array of tokenIds from the BAYC/MAYC pool * @param nftAsset Contract address of BAYC/MAYC * @param _nfts Array of NFTs owned and committed by the msg.sender * @dev Need check User health factor > 1. */ function claimApeCoin(address nftAsset, uint256[] calldata _nfts) external; /** * @notice Withdraw staked ApeCoin from the BAKC pool * @param nftAsset Contract address of BAYC/MAYC * @param _nftPairs Array of Paired BAYC/MAYC NFT's with staked amounts * @dev Need check User health factor > 1. */ function withdrawBAKC( address nftAsset, ApeCoinStaking.PairNftWithdrawWithAmount[] memory _nftPairs ) external; /** * @notice Claim rewards for array of tokenIds from the BAYC/MAYC pool * @param nftAsset Contract address of BAYC/MAYC * @param _nftPairs Array of Paired BAYC/MAYC NFT's * @dev Need check User health factor > 1. */ function claimBAKC( address nftAsset, ApeCoinStaking.PairNft[] calldata _nftPairs ) external; /** * @notice Unstake user Ape coin staking position and repay user debt * @param nftAsset Contract address of BAYC/MAYC * @param tokenId Token id of the ape staking position on * @dev Need check User health factor > 1. */ function unstakeApePositionAndRepay(address nftAsset, uint256 tokenId) external; /** * @notice repay asset and supply asset for user * @param underlyingAsset Contract address of BAYC/MAYC * @param onBehalfOf The beneficiary of the repay and supply * @dev Convenient callback function for unstakeApePositionAndRepay. Only NToken of BAYC/MAYC can call this. */ function repayAndSupply( address underlyingAsset, address onBehalfOf, uint256 totalAmount ) external; /** * @notice Claim user Ape coin reward and deposit to ape compound to get cApe, then deposit cApe to Lending pool for user * @param nftAsset Contract address of BAYC/MAYC * @param users array of user address * @param tokenIds array of user tokenId array */ function claimApeAndCompound( address nftAsset, address[] calldata users, uint256[][] calldata tokenIds ) external; /** * @notice Claim user BAKC paired Ape coin reward and deposit to ape compound to get cApe, then deposit cApe to Lending pool for user * @param nftAsset Contract address of BAYC/MAYC * @param users array of user address * @param _nftPairs Array of Paired BAYC/MAYC NFT's */ function claimPairedApeAndCompound( address nftAsset, address[] calldata users, ApeCoinStaking.PairNft[][] calldata _nftPairs ) external; /** * @notice get current incentive fee rate for claiming ape position reward to compound */ function getApeCompoundFeeRate() external returns (uint256); }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {IPoolAddressesProvider} from "./IPoolAddressesProvider.sol"; import {ITimeLock} from "./ITimeLock.sol"; import {DataTypes} from "../protocol/libraries/types/DataTypes.sol"; /** * @title IPool * * @notice Defines the basic interface for an ParaSpace Pool. **/ interface IPoolCore { /** * @dev Emitted on supply() * @param reserve The address of the underlying asset of the reserve * @param user The address initiating the supply * @param onBehalfOf The beneficiary of the supply, receiving the xTokens * @param amount The amount supplied * @param referralCode The referral code used **/ event Supply( address indexed reserve, address user, address indexed onBehalfOf, uint256 amount, uint16 indexed referralCode ); event SupplyERC721( address indexed reserve, address user, address indexed onBehalfOf, DataTypes.ERC721SupplyParams[] tokenData, uint16 indexed referralCode, bool fromNToken ); /** * @dev Emitted on withdraw() * @param reserve The address of the underlying asset being withdrawn * @param user The address initiating the withdrawal, owner of xTokens * @param to The address that will receive the underlying asset * @param amount The amount to be withdrawn **/ event Withdraw( address indexed reserve, address indexed user, address indexed to, uint256 amount ); /** * @dev Emitted on withdrawERC721() * @param reserve The address of the underlying asset being withdrawn * @param user The address initiating the withdrawal, owner of xTokens * @param to The address that will receive the underlying asset * @param tokenIds The tokenIds to be withdrawn **/ event WithdrawERC721( address indexed reserve, address indexed user, address indexed to, uint256[] tokenIds ); /** * @dev Emitted on borrow() and flashLoan() when debt needs to be opened * @param reserve The address of the underlying asset being borrowed * @param user The address of the user initiating the borrow(), receiving the funds on borrow() or just * initiator of the transaction on flashLoan() * @param onBehalfOf The address that will be getting the debt * @param amount The amount borrowed out * @param borrowRate The numeric rate at which the user has borrowed, expressed in ray * @param referralCode The referral code used **/ event Borrow( address indexed reserve, address user, address indexed onBehalfOf, uint256 amount, uint256 borrowRate, uint16 indexed referralCode ); /** * @dev Emitted on repay() * @param reserve The address of the underlying asset of the reserve * @param user The beneficiary of the repayment, getting his debt reduced * @param repayer The address of the user initiating the repay(), providing the funds * @param amount The amount repaid * @param usePTokens True if the repayment is done using xTokens, `false` if done with underlying asset directly **/ event Repay( address indexed reserve, address indexed user, address indexed repayer, uint256 amount, bool usePTokens ); /** * @dev Emitted on setUserUseERC20AsCollateral() * @param reserve The address of the underlying asset of the reserve * @param user The address of the user enabling the usage as collateral **/ event ReserveUsedAsCollateralEnabled( address indexed reserve, address indexed user ); /** * @dev Emitted on setUserUseERC20AsCollateral() * @param reserve The address of the underlying asset of the reserve * @param user The address of the user enabling the usage as collateral **/ event ReserveUsedAsCollateralDisabled( address indexed reserve, address indexed user ); /** * @dev Emitted when a borrower is liquidated. * @param collateralAsset The address of the underlying asset used as collateral, to receive as result of the liquidation * @param liquidationAsset The address of the underlying borrowed asset to be repaid with the liquidation * @param borrower The address of the borrower getting liquidated * @param liquidationAmount The debt amount of borrowed `asset` the liquidator wants to cover * @param liquidatedCollateralAmount The amount of collateral received by the liquidator * @param liquidator The address of the liquidator * @param receivePToken True if the liquidators wants to receive the collateral xTokens, `false` if he wants * to receive the underlying collateral asset directly **/ event LiquidateERC20( address indexed collateralAsset, address indexed liquidationAsset, address indexed borrower, uint256 liquidationAmount, uint256 liquidatedCollateralAmount, address liquidator, bool receivePToken ); /** * @dev Emitted when a borrower's ERC721 asset is liquidated. * @param collateralAsset The address of the underlying asset used as collateral, to receive as result of the liquidation * @param liquidationAsset The address of the underlying borrowed asset to be repaid with the liquidation * @param borrower The address of the borrower getting liquidated * @param liquidationAmount The debt amount of borrowed `asset` the liquidator wants to cover * @param liquidatedCollateralTokenId The token id of ERC721 asset received by the liquidator * @param liquidator The address of the liquidator * @param receiveNToken True if the liquidators wants to receive the collateral NTokens, `false` if he wants * to receive the underlying collateral asset directly **/ event LiquidateERC721( address indexed collateralAsset, address indexed liquidationAsset, address indexed borrower, uint256 liquidationAmount, uint256 liquidatedCollateralTokenId, address liquidator, bool receiveNToken ); /** * @dev Emitted on flashClaim * @param target The address of the flash loan receiver contract * @param initiator The address initiating the flash claim * @param nftAsset address of the underlying asset of NFT * @param tokenId The token id of the asset being flash borrowed **/ event FlashClaim( address indexed target, address indexed initiator, address indexed nftAsset, uint256 tokenId ); /** * @dev Event triggered when a new auction is started for a collateral asset. * @param user The address of the user who started the auction. * @param collateralAsset The address of the collateral asset for the auction. * @param collateralTokenId The ID of the collateral token for the auction. */ event AuctionStarted( address indexed user, address indexed collateralAsset, uint256 indexed collateralTokenId ); /** * @dev Event triggered when an auction for a collateral asset ends. * @param user The address of the user who owns the collateral asset. * @param collateralAsset The address of the collateral asset for the auction. * @param collateralTokenId The ID of the collateral token for the auction. */ event AuctionEnded( address indexed user, address indexed collateralAsset, uint256 indexed collateralTokenId ); /** * @dev Allows smart contracts to access the tokens within one transaction, as long as the tokens taken is returned. * * Requirements: * - `nftTokenIds` must exist. * * @param receiverAddress The address of the contract receiving the tokens, implementing the IFlashClaimReceiver interface * @param nftAssets addresses of the underlying asset of NFT * @param nftTokenIds token ids of the underlying asset * @param params Variadic packed params to pass to the receiver as extra information */ function flashClaim( address receiverAddress, address[] calldata nftAssets, uint256[][] calldata nftTokenIds, bytes calldata params ) external; /** * @notice Supplies an `amount` of underlying asset into the reserve, receiving in return overlying xTokens. * - E.g. User supplies 100 USDC and gets in return 100 pUSDC * @param asset The address of the underlying asset to supply * @param amount The amount to be supplied * @param onBehalfOf The address that will receive the xTokens, same as msg.sender if the user * wants to receive them on his own wallet, or a different address if the beneficiary of xTokens * is a different wallet * @param referralCode Code used to register the integrator originating the operation, for potential rewards. * 0 if the action is executed directly by the user, without any middle-man **/ function supply( address asset, uint256 amount, address onBehalfOf, uint16 referralCode ) external; /** * @notice Supplies multiple `tokenIds` of underlying ERC721 asset into the reserve, receiving in return overlying nTokens. * - E.g. User supplies 2 BAYC and gets in return 2 nBAYC * @param asset The address of the underlying asset to supply * @param tokenData The list of tokenIds and their collateral configs to be supplied * @param onBehalfOf The address that will receive the xTokens, same as msg.sender if the user * wants to receive them on his own wallet, or a different address if the beneficiary of xTokens * is a different wallet * @param referralCode Code used to register the integrator originating the operation, for potential rewards. * 0 if the action is executed directly by the user, without any middle-man **/ function supplyERC721( address asset, DataTypes.ERC721SupplyParams[] calldata tokenData, address onBehalfOf, uint16 referralCode ) external; /** * @notice Same as `supplyERC721` but this can only be called by NToken contract and doesn't require sending the underlying asset. * @param asset The address of the underlying asset to supply * @param tokenData The list of tokenIds and their collateral configs to be supplied * @param onBehalfOf The address that will receive the xTokens **/ function supplyERC721FromNToken( address asset, DataTypes.ERC721SupplyParams[] calldata tokenData, address onBehalfOf ) external; /** * @notice Supply with transfer approval of asset to be supplied done via permit function * see: https://eips.ethereum.org/EIPS/eip-2612 and https://eips.ethereum.org/EIPS/eip-713 * @param asset The address of the underlying asset to supply * @param amount The amount to be supplied * @param onBehalfOf The address that will receive the xTokens, same as msg.sender if the user * wants to receive them on his own wallet, or a different address if the beneficiary of xTokens * is a different wallet * @param deadline The deadline timestamp that the permit is valid * @param referralCode Code used to register the integrator originating the operation, for potential rewards. * 0 if the action is executed directly by the user, without any middle-man * @param permitV The V parameter of ERC712 permit sig * @param permitR The R parameter of ERC712 permit sig * @param permitS The S parameter of ERC712 permit sig **/ function supplyWithPermit( address asset, uint256 amount, address onBehalfOf, uint16 referralCode, uint256 deadline, uint8 permitV, bytes32 permitR, bytes32 permitS ) external; /** * @notice Withdraws an `amount` of underlying asset from the reserve, burning the equivalent xTokens owned * E.g. User has 100 pUSDC, calls withdraw() and receives 100 USDC, burning the 100 pUSDC * @param asset The address of the underlying asset to withdraw * @param amount The underlying amount to be withdrawn * - Send the value type(uint256).max in order to withdraw the whole xToken balance * @param to The address that will receive the underlying, same as msg.sender if the user * wants to receive it on his own wallet, or a different address if the beneficiary is a * different wallet * @return The final amount withdrawn **/ function withdraw( address asset, uint256 amount, address to ) external returns (uint256); /** * @notice Withdraws multiple `tokenIds` of underlying ERC721 asset from the reserve, burning the equivalent nTokens owned * E.g. User has 2 nBAYC, calls withdraw() and receives 2 BAYC, burning the 2 nBAYC * @param asset The address of the underlying asset to withdraw * @param tokenIds The underlying tokenIds to be withdrawn * - Send the value type(uint256).max in order to withdraw the whole xToken balance * @param to The address that will receive the underlying, same as msg.sender if the user * wants to receive it on his own wallet, or a different address if the beneficiary is a * different wallet * @return The final amount withdrawn **/ function withdrawERC721( address asset, uint256[] calldata tokenIds, address to ) external returns (uint256); /** * @notice Decreases liquidity for underlying Uniswap V3 NFT LP and validates * that the user respects liquidation checks. * @param asset The asset address of uniswapV3 * @param tokenId The id of the erc721 token * @param liquidityDecrease The amount of liquidity to remove of LP * @param amount0Min The minimum amount to remove of token0 * @param amount1Min The minimum amount to remove of token1 * @param receiveEthAsWeth If convert weth to ETH */ function decreaseUniswapV3Liquidity( address asset, uint256 tokenId, uint128 liquidityDecrease, uint256 amount0Min, uint256 amount1Min, bool receiveEthAsWeth ) external; /** * @notice Allows users to borrow a specific `amount` of the reserve underlying asset, provided that the borrower * already supplied enough collateral, or he was given enough allowance by a credit delegator on the * corresponding debt token (VariableDebtToken) * - E.g. User borrows 100 USDC passing as `onBehalfOf` his own address, receiving the 100 USDC in his wallet * and 100 stable/variable debt tokens * @param asset The address of the underlying asset to borrow * @param amount The amount to be borrowed * @param referralCode The code used to register the integrator originating the operation, for potential rewards. * 0 if the action is executed directly by the user, without any middle-man * @param onBehalfOf The address of the user who will receive the debt. Should be the address of the borrower itself * calling the function if he wants to borrow against his own collateral, or the address of the credit delegator * if he has been given credit delegation allowance **/ function borrow( address asset, uint256 amount, uint16 referralCode, address onBehalfOf ) external; /** * @notice Repays a borrowed `amount` on a specific reserve, burning the equivalent debt tokens owned * - E.g. User repays 100 USDC, burning 100 variable/stable debt tokens of the `onBehalfOf` address * @param asset The address of the borrowed underlying asset previously borrowed * @param amount The amount to repay * - Send the value type(uint256).max in order to repay the whole debt for `asset` on the specific `debtMode` * @param onBehalfOf The address of the user who will get his debt reduced/removed. Should be the address of the * user calling the function if he wants to reduce/remove his own debt, or the address of any other * other borrower whose debt should be removed * @return The final amount repaid **/ function repay( address asset, uint256 amount, address onBehalfOf ) external returns (uint256); /** * @notice Repays a borrowed `amount` on a specific reserve using the reserve xTokens, burning the * equivalent debt tokens * - E.g. User repays 100 USDC using 100 pUSDC, burning 100 variable/stable debt tokens * @dev Passing uint256.max as amount will clean up any residual xToken dust balance, if the user xToken * balance is not enough to cover the whole debt * @param asset The address of the borrowed underlying asset previously borrowed * @param amount The amount to repay * - Send the value type(uint256).max in order to repay the whole debt for `asset` on the specific `debtMode` * @return The final amount repaid **/ function repayWithPTokens(address asset, uint256 amount) external returns (uint256); /** * @notice Repay with transfer approval of asset to be repaid done via permit function * see: https://eips.ethereum.org/EIPS/eip-2612 and https://eips.ethereum.org/EIPS/eip-713 * @param asset The address of the borrowed underlying asset previously borrowed * @param amount The amount to repay * - Send the value type(uint256).max in order to repay the whole debt for `asset` on the specific `debtMode` * @param onBehalfOf Address of the user who will get his debt reduced/removed. Should be the address of the * user calling the function if he wants to reduce/remove his own debt, or the address of any other * other borrower whose debt should be removed * @param deadline The deadline timestamp that the permit is valid * @param permitV The V parameter of ERC712 permit sig * @param permitR The R parameter of ERC712 permit sig * @param permitS The S parameter of ERC712 permit sig * @return The final amount repaid **/ function repayWithPermit( address asset, uint256 amount, address onBehalfOf, uint256 deadline, uint8 permitV, bytes32 permitR, bytes32 permitS ) external returns (uint256); /** * @notice Allows suppliers to enable/disable a specific supplied asset as collateral * @param asset The address of the underlying asset supplied * @param useAsCollateral True if the user wants to use the supply as collateral, false otherwise **/ function setUserUseERC20AsCollateral(address asset, bool useAsCollateral) external; /** * @notice Allows suppliers to enable/disable a specific supplied ERC721 asset with a tokenID as collateral * @param asset The address of the underlying asset supplied * @param tokenIds the ids of the supplied ERC721 token * @param useAsCollateral True if the user wants to use the supply as collateral, false otherwise **/ function setUserUseERC721AsCollateral( address asset, uint256[] calldata tokenIds, bool useAsCollateral ) external; /** * @notice Function to liquidate a non-healthy position collateral-wise, with Health Factor below 1 * - The caller (liquidator) covers `liquidationAmount` amount of debt of the user getting liquidated, and receives * a proportionally amount of the `collateralAsset` plus a bonus to cover market risk * @param collateralAsset The address of the underlying asset used as collateral, to receive as result of the liquidation * @param liquidationAsset The address of the underlying borrowed asset to be repaid with the liquidation * @param user The address of the borrower getting liquidated * @param liquidationAmount The debt amount of borrowed `asset` the liquidator wants to cover * @param receivePToken True if the liquidators wants to receive the collateral xTokens, `false` if he wants * to receive the underlying collateral asset directly **/ function liquidateERC20( address collateralAsset, address liquidationAsset, address user, uint256 liquidationAmount, bool receivePToken ) external payable; function liquidateERC721( address collateralAsset, address user, uint256 collateralTokenId, uint256 liquidationAmount, bool receiveNToken ) external payable; /** * @notice Start the auction on user's specific NFT collateral * @param user The address of the user * @param collateralAsset The address of the NFT collateral * @param collateralTokenId The tokenId of the NFT collateral **/ function startAuction( address user, address collateralAsset, uint256 collateralTokenId ) external; /** * @notice End specific user's auction * @param user The address of the user * @param collateralAsset The address of the NFT collateral * @param collateralTokenId The tokenId of the NFT collateral **/ function endAuction( address user, address collateralAsset, uint256 collateralTokenId ) external; /** * @notice Returns the configuration of the user across all the reserves * @param user The user address * @return The configuration of the user **/ function getUserConfiguration(address user) external view returns (DataTypes.UserConfigurationMap memory); /** * @notice Returns the configuration of the reserve * @param asset The address of the underlying asset of the reserve * @return The configuration of the reserve **/ function getConfiguration(address asset) external view returns (DataTypes.ReserveConfigurationMap memory); /** * @notice Returns the normalized income normalized income of the reserve * @param asset The address of the underlying asset of the reserve * @return The reserve's normalized income */ function getReserveNormalizedIncome(address asset) external view returns (uint256); /** * @notice Returns the normalized variable debt per unit of asset * @param asset The address of the underlying asset of the reserve * @return The reserve normalized variable debt */ function getReserveNormalizedVariableDebt(address asset) external view returns (uint256); /** * @notice Returns the state and configuration of the reserve * @param asset The address of the underlying asset of the reserve * @return The state and configuration data of the reserve **/ function getReserveData(address asset) external view returns (DataTypes.ReserveData memory); function getReserveXToken(address asset) external view returns (address); /** * @notice Validates and finalizes an PToken transfer * @dev Only callable by the overlying xToken of the `asset` * @param asset The address of the underlying asset of the xToken * @param from The user from which the xTokens are transferred * @param to The user receiving the xTokens * @param amount The amount being transferred/withdrawn * @param balanceFromBefore The xToken balance of the `from` user before the transfer * @param balanceToBefore The xToken balance of the `to` user before the transfer */ function finalizeTransfer( address asset, address from, address to, bool usedAsCollateral, uint256 amount, uint256 balanceFromBefore, uint256 balanceToBefore ) external; /** * @notice Validates and finalizes an NToken transfer * @dev Only callable by the overlying xToken of the `asset` * @param asset The address of the underlying asset of the xToken * @param tokenId The tokenId of the ERC721 asset * @param from The user from which the xTokens are transferred * @param to The user receiving the xTokens * @param balanceFromBefore The xToken balance of the `from` user before the transfer */ function finalizeTransferERC721( address asset, uint256 tokenId, address from, address to, bool usedAsCollateral, uint256 balanceFromBefore ) external; /** * @notice Returns the list of the underlying assets of all the initialized reserves * @dev It does not include dropped reserves * @return The addresses of the underlying assets of the initialized reserves **/ function getReservesList() external view returns (address[] memory); /** * @notice Returns the address of the underlying asset of a reserve by the reserve id as stored in the DataTypes.ReserveData struct * @param id The id of the reserve as stored in the DataTypes.ReserveData struct * @return The address of the reserve associated with id **/ function getReserveAddressById(uint16 id) external view returns (address); /** * @notice Returns the auction related data of specific asset collection and token id. * @param ntokenAsset The address of ntoken * @param tokenId The token id which is currently auctioned for liquidation * @return The auction related data of the corresponding (ntokenAsset, tokenId) */ function getAuctionData(address ntokenAsset, uint256 tokenId) external view returns (DataTypes.AuctionData memory); // function getAuctionData(address user, address) external view returns (DataTypes.AuctionData memory); /** * @notice Returns the PoolAddressesProvider connected to this contract * @return The address of the PoolAddressesProvider **/ function ADDRESSES_PROVIDER() external view returns (IPoolAddressesProvider); function TIME_LOCK() external view returns (ITimeLock); /** * @notice Returns the maximum number of reserves supported to be listed in this Pool * @return The maximum number of reserves supported */ function MAX_NUMBER_RESERVES() external view returns (uint16); /** * @notice Returns the auction recovery health factor * @return The auction recovery health factor */ function AUCTION_RECOVERY_HEALTH_FACTOR() external view returns (uint64); }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {IPoolAddressesProvider} from "./IPoolAddressesProvider.sol"; import {DataTypes} from "../protocol/libraries/types/DataTypes.sol"; /** * @title IPool * * @notice Defines the basic interface for an ParaSpace Pool. **/ interface IPoolMarketplace { event BuyWithCredit( bytes32 indexed marketplaceId, DataTypes.OrderInfo orderInfo, DataTypes.Credit credit ); event AcceptBidWithCredit( bytes32 indexed marketplaceId, DataTypes.OrderInfo orderInfo, DataTypes.Credit credit ); /** * @notice Implements the buyWithCredit feature. BuyWithCredit allows users to buy NFT from various NFT marketplaces * including OpenSea, LooksRare, X2Y2 etc. Users can use NFT's credit and will need to pay at most (1 - LTV) * $NFT * @dev * @param marketplaceId The marketplace identifier * @param payload The encoded parameters to be passed to marketplace contract (selector eliminated) * @param credit The credit that user would like to use for this purchase * @param referralCode The referral code used */ function buyWithCredit( bytes32 marketplaceId, bytes calldata payload, DataTypes.Credit calldata credit, uint16 referralCode ) external payable; /** * @notice Implements the batchBuyWithCredit feature. BuyWithCredit allows users to buy NFT from various NFT marketplaces * including OpenSea, LooksRare, X2Y2 etc. Users can use NFT's credit and will need to pay at most (1 - LTV) * $NFT * @dev marketplaceIds[i] should match payload[i] and credits[i] * @param marketplaceIds The marketplace identifiers * @param payloads The encoded parameters to be passed to marketplace contract (selector eliminated) * @param credits The credits that user would like to use for this purchase * @param referralCode The referral code used */ function batchBuyWithCredit( bytes32[] calldata marketplaceIds, bytes[] calldata payloads, DataTypes.Credit[] calldata credits, uint16 referralCode ) external payable; /** * @notice Implements the acceptBidWithCredit feature. AcceptBidWithCredit allows users to * accept a leveraged bid on ParaSpace NFT marketplace. Users can submit leveraged bid and pay * at most (1 - LTV) * $NFT * @dev The nft receiver just needs to do the downpayment * @param marketplaceId The marketplace identifier * @param payload The encoded parameters to be passed to marketplace contract (selector eliminated) * @param credit The credit that user would like to use for this purchase * @param onBehalfOf Address of the user who will sell the NFT * @param referralCode The referral code used */ function acceptBidWithCredit( bytes32 marketplaceId, bytes calldata payload, DataTypes.Credit calldata credit, address onBehalfOf, uint16 referralCode ) external; /** * @notice Implements the batchAcceptBidWithCredit feature. AcceptBidWithCredit allows users to * accept a leveraged bid on ParaSpace NFT marketplace. Users can submit leveraged bid and pay * at most (1 - LTV) * $NFT * @dev The nft receiver just needs to do the downpayment * @param marketplaceIds The marketplace identifiers * @param payloads The encoded parameters to be passed to marketplace contract (selector eliminated) * @param credits The credits that the makers have approved to use for this purchase * @param onBehalfOf Address of the user who will sell the NFTs * @param referralCode The referral code used */ function batchAcceptBidWithCredit( bytes32[] calldata marketplaceIds, bytes[] calldata payloads, DataTypes.Credit[] calldata credits, address onBehalfOf, uint16 referralCode ) external; }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {IPoolAddressesProvider} from "./IPoolAddressesProvider.sol"; import {DataTypes} from "../protocol/libraries/types/DataTypes.sol"; /** * @title IPool * * @notice Defines the basic interface for an ParaSpace Pool. **/ interface IPoolParameters { /** * @dev Emitted when the state of a reserve is updated. * @param reserve The address of the underlying asset of the reserve * @param liquidityRate The next liquidity rate * @param variableBorrowRate The next variable borrow rate * @param liquidityIndex The next liquidity index * @param variableBorrowIndex The next variable borrow index **/ event ReserveDataUpdated( address indexed reserve, uint256 liquidityRate, uint256 variableBorrowRate, uint256 liquidityIndex, uint256 variableBorrowIndex ); /** * @dev Emitted when the value of claim for yield incentive rate update **/ event ClaimApeForYieldIncentiveUpdated(uint256 oldValue, uint256 newValue); /** * @notice Initializes a reserve, activating it, assigning an xToken and debt tokens and an * interest rate strategy * @dev Only callable by the PoolConfigurator contract * @param asset The address of the underlying asset of the reserve * @param xTokenAddress The address of the xToken that will be assigned to the reserve * @param variableDebtAddress The address of the VariableDebtToken that will be assigned to the reserve * @param interestRateStrategyAddress The address of the interest rate strategy contract * @param auctionStrategyAddress The address of the auction rate strategy contract * @param timeLockStrategyAddress The address of the timeLock strategy contract **/ function initReserve( address asset, address xTokenAddress, address variableDebtAddress, address interestRateStrategyAddress, address auctionStrategyAddress, address timeLockStrategyAddress ) external; /** * @notice Drop a reserve * @dev Only callable by the PoolConfigurator contract * @param asset The address of the underlying asset of the reserve **/ function dropReserve(address asset) external; /** * @notice Updates the address of the interest rate strategy contract * @dev Only callable by the PoolConfigurator contract * @param asset The address of the underlying asset of the reserve * @param rateStrategyAddress The address of the interest rate strategy contract **/ function setReserveInterestRateStrategyAddress( address asset, address rateStrategyAddress ) external; function setReserveTimeLockStrategyAddress( address asset, address newStrategyAddress ) external; /** * @notice Updates the address of the auction strategy contract * @dev Only callable by the PoolConfigurator contract * @param asset The address of the underlying asset of the reserve * @param auctionStrategyAddress The address of the auction strategy contract **/ function setReserveAuctionStrategyAddress( address asset, address auctionStrategyAddress ) external; /** * @notice Sets the configuration bitmap of the reserve as a whole * @dev Only callable by the PoolConfigurator contract * @param asset The address of the underlying asset of the reserve * @param configuration The new configuration bitmap **/ function setConfiguration( address asset, DataTypes.ReserveConfigurationMap calldata configuration ) external; /** * @notice Mints the assets accrued through the reserve factor to the treasury in the form of xTokens * @param assets The list of reserves for which the minting needs to be executed **/ function mintToTreasury(address[] calldata assets) external; /** * @notice Rescue and transfer tokens locked in this contract * @param assetType The asset type of the token * @param token The address of the token * @param to The address of the recipient * @param amountOrTokenId The amount or id of token to transfer */ function rescueTokens( DataTypes.AssetType assetType, address token, address to, uint256 amountOrTokenId ) external; /** * @notice grant token's an unlimited allowance value to the 'to' address * @param token The ERC20 token address * @param to The address receive the grant */ function unlimitedApproveTo(address token, address to) external; /** * @notice reset token's allowance value to the 'to' address * @param token The ERC20 token address * @param to The address receive the grant */ function revokeUnlimitedApprove(address token, address to) external; /** * @notice undate fee percentage for claim ape for compound * @param fee new fee percentage */ function setClaimApeForCompoundFee(uint256 fee) external; /** * @notice undate ape compound strategy * @param strategy new compound strategy */ function setApeCompoundStrategy( DataTypes.ApeCompoundStrategy calldata strategy ) external; /** * @notice get user ape compound strategy * @param user The user address */ function getUserApeCompoundStrategy(address user) external view returns (DataTypes.ApeCompoundStrategy memory); /** * @notice Set the auction recovery health factor * @param value The new auction health factor */ function setAuctionRecoveryHealthFactor(uint64 value) external; /** * @notice Set auction validity time, all auctions triggered before the validity time will be considered as invalid * @param user The user address */ function setAuctionValidityTime(address user) external; /** * @notice Returns the user account data across all the reserves * @param user The address of the user * @return totalCollateralBase The total collateral of the user in the base currency used by the price feed * @return totalDebtBase The total debt of the user in the base currency used by the price feed * @return availableBorrowsBase The borrowing power left of the user in the base currency used by the price feed * @return currentLiquidationThreshold The liquidation threshold of the user * @return ltv The loan to value of The user * @return healthFactor The current health factor of the user **/ function getUserAccountData(address user) external view returns ( uint256 totalCollateralBase, uint256 totalDebtBase, uint256 availableBorrowsBase, uint256 currentLiquidationThreshold, uint256 ltv, uint256 healthFactor, uint256 erc721HealthFactor ); /** * @notice Returns Ltv and Liquidation Threshold for the asset * @param asset The address of the asset * @param tokenId The tokenId of the asset * @return ltv The loan to value of the asset * @return lt The liquidation threshold value of the asset **/ function getAssetLtvAndLT(address asset, uint256 tokenId) external view returns (uint256 ltv, uint256 lt); }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {DataTypes} from "../protocol/libraries/types/DataTypes.sol"; import {ApeCoinStaking} from "../dependencies/yoga-labs/ApeCoinStaking.sol"; /** * @title IPool * * @notice Defines the basic interface for an ParaSpace Pool. **/ interface IPoolPositionMover { function movePositionFromBendDAO(uint256[] calldata loanIds) external; //# Migration step // //0. User needs to breakup P2P orders on their own //1. Repay Debt // 1. if it's cAPE then deposit borrowed APE into old cAPE pool then repay // 2. if it's not then just repay with borrowed tokens //2. burn old NToken // 1. move old NToken to new Pool, if it's staking BAYC/MAYC/BAKC it'll be automatically unstaked // 2. withdrawERC721 and specify new NToken as recipient // 3. mint new NToken //3. burn old PToken // 1. move old PToken to new Pool // 2. withdraw and specify new PToken as recipient // 3. mint new NToken //4. Mint new debt function movePositionFromParaSpace( DataTypes.ParaSpacePositionMoveInfo calldata moveInfo ) external; function claimUnderlying( address[] calldata assets, uint256[][] calldata agreementIds ) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.0; /// @title The interface for StakefishValidator /// @notice Defines implementation of the wallet (deposit, withdraw, collect fees) interface IStakefishValidator { enum State { PreDeposit, PostDeposit, Active, ExitRequested, Exited, Withdrawn, Burnable } /// @dev aligns into 32 byte struct StateChange { State state; // 1 byte bytes15 userData; // 15 byte (future use) uint128 changedAt; // 16 byte } function validatorIndex() external view returns (uint256); function pubkey() external view returns (bytes memory); function withdrawnBalance() external view returns (uint256); function feePoolAddress() external view returns (address); function stateHistory(uint256 index) external view returns (StateChange memory); /// @notice Inspect state of the change function lastStateChange() external view returns (StateChange memory); /// @notice NFT Owner requests a validator exit /// State.Running -> State.ExitRequested /// emit ValidatorExitRequest(pubkey) function requestExit() external; /// @notice user withdraw balance and charge a fee function withdraw() external; /// @notice get pending fee pool rewards function pendingFeePoolReward() external view returns (uint256, uint256); /// @notice claim fee pool and forward to nft owner function claimFeePool(uint256 amountRequested) external; function getProtocolFee() external view returns (uint256); function getNFTArtUrl() external view returns (string memory); /// @notice computes commission, useful for showing on UI function computeCommission(uint256 amount) external view returns (uint256); function render() external view returns (string memory); }
// SPDX-License-Identifier: AGPL-3.0 pragma solidity ^0.8.0; import {DataTypes} from "../protocol/libraries/types/DataTypes.sol"; /** @title ITimeLock interface for the TimeLock smart contract */ interface ITimeLock { /** @dev Struct representing a time-lock agreement * @param assetType Type of the asset involved * @param actionType Type of action for the time-lock * @param isFrozen Indicates if the agreement is frozen * @param asset Address of the asset * @param beneficiary Address of the beneficiary * @param releaseTime Timestamp when the assets can be claimed * @param tokenIdsOrAmounts Array of token IDs or amounts */ struct Agreement { DataTypes.AssetType assetType; DataTypes.TimeLockActionType actionType; bool isFrozen; address asset; address beneficiary; uint48 releaseTime; uint256[] tokenIdsOrAmounts; } /** @notice Event emitted when a new time-lock agreement is created * @param agreementId ID of the created agreement * @param assetType Type of the asset involved * @param actionType Type of action for the time-lock * @param asset Address of the asset * @param tokenIdsOrAmounts Array of token IDs or amounts * @param beneficiary Address of the beneficiary * @param releaseTime Timestamp when the assets can be claimed */ event AgreementCreated( uint256 agreementId, DataTypes.AssetType assetType, DataTypes.TimeLockActionType actionType, address indexed asset, uint256[] tokenIdsOrAmounts, address indexed beneficiary, uint48 releaseTime ); /** @notice Event emitted when a time-lock agreement is claimed * @param agreementId ID of the claimed agreement * @param assetType Type of the asset involved * @param actionType Type of action for the time-lock * @param asset Address of the asset * @param tokenIdsOrAmounts Array of token IDs or amounts * @param beneficiary Address of the beneficiary */ event AgreementClaimed( uint256 agreementId, DataTypes.AssetType assetType, DataTypes.TimeLockActionType actionType, address indexed asset, uint256[] tokenIdsOrAmounts, address indexed beneficiary ); /** @notice Event emitted when a time-lock agreement is frozen or unfrozen * @param agreementId ID of the affected agreement * @param value Indicates whether the agreement is frozen (true) or unfrozen (false) */ event AgreementFrozen(uint256 agreementId, bool value); /** @notice Event emitted when the entire TimeLock contract is frozen or unfrozen * @param value Indicates whether the contract is frozen (true) or unfrozen (false) */ event TimeLockFrozen(bool value); /** @dev Function to create a new time-lock agreement * @param assetType Type of the asset involved * @param actionType Type of action for the time-lock * @param asset Address of the asset * @param tokenIdsOrAmounts Array of token IDs or amounts * @param beneficiary Address of the beneficiary * @param releaseTime Timestamp when the assets can be claimed * @return agreementId Returns the ID of the created agreement */ function createAgreement( DataTypes.AssetType assetType, DataTypes.TimeLockActionType actionType, address asset, uint256[] memory tokenIdsOrAmounts, address beneficiary, uint48 releaseTime ) external returns (uint256 agreementId); /** @dev Function to claim assets from time-lock agreements * @param agreementIds Array of agreement IDs to be claimed */ function claim(uint256[] calldata agreementIds) external; /** @dev Function to claim MoonBird from time-lock agreements * @param agreementIds Array of agreement IDs to be claimed */ function claimMoonBirds(uint256[] calldata agreementIds) external; /** @dev Function to freeze a specific time-lock agreement * @param agreementId ID of the agreement to be frozen */ function freezeAgreement(uint256 agreementId) external; /** @dev Function to unfreeze a specific time-lock agreement * @param agreementId ID of the agreement to be unfrozen */ function unfreezeAgreement(uint256 agreementId) external; /** @dev Function to freeze all time-lock agreements * @notice This function can only be called by an authorized user */ function freezeAllAgreements() external; /** @dev Function to unfreeze all time-lock agreements * @notice This function can only be called by an authorized user */ function unfreezeAllAgreements() external; }
// SPDX-License-Identifier: agpl-3.0 pragma solidity ^0.8.0; /** * @dev Interface for a permittable ERC721 contract * See https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC72 allowance (see {IERC721-allowance}) by * presenting a message signed by the account. By not relying on {IERC721-approve}, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. */ interface IPunks { function balanceOf(address account) external view returns (uint256); function punkIndexToAddress(uint256 punkIndex) external view returns (address owner); function buyPunk(uint256 punkIndex) external; function transferPunk(address to, uint256 punkIndex) external; }
// SPDX-License-Identifier: agpl-3.0 pragma solidity ^0.8.0; interface IWETH { function deposit() external payable; function withdraw(uint256) external; function approve(address guy, uint256 wad) external returns (bool); function allowance(address owner, address spender) external returns (uint256); function transferFrom( address src, address dst, uint256 wad ) external returns (bool); }
// SPDX-License-Identifier: agpl-3.0 pragma solidity ^0.8.0; import {IERC721} from "../../../contracts/dependencies/openzeppelin/contracts/IERC721.sol"; //import "@openzeppelin/contracts/token/ERC721/IERC721.sol"; /** * @dev Interface for a permittable ERC721 contract * See https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC72 allowance (see {IERC721-allowance}) by * presenting a message signed by the account. By not relying on {IERC721-approve}, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. */ interface IWrappedPunks is IERC721 { function punkContract() external view returns (address); function mint(uint256 punkIndex) external; function burn(uint256 punkIndex) external; function registerProxy() external; function proxyInfo(address user) external returns (address proxy); }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.0; import {Errors} from "../helpers/Errors.sol"; import {DataTypes} from "../types/DataTypes.sol"; /** * @title ReserveConfiguration library * * @notice Implements the bitmap logic to handle the reserve configuration */ library ReserveConfiguration { uint256 internal constant LTV_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000; // prettier-ignore uint256 internal constant LIQUIDATION_THRESHOLD_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000FFFF; // prettier-ignore uint256 internal constant LIQUIDATION_BONUS_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000FFFFFFFF; // prettier-ignore uint256 internal constant DECIMALS_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF00FFFFFFFFFFFF; // prettier-ignore uint256 internal constant ACTIVE_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant FROZEN_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFDFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant BORROWING_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFBFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant STABLE_BORROWING_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF7FFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant PAUSED_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant SILOED_BORROWING_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFBFFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant RESERVE_FACTOR_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF0000FFFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant BORROW_CAP_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF000000000FFFFFFFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant SUPPLY_CAP_MASK = 0xFFFFFFFFFFFFFFFFFFFFFFFFFF000000000FFFFFFFFFFFFFFFFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant LIQUIDATION_PROTOCOL_FEE_MASK = 0xFFFFFFFFFFFFFFFFFFFFFF0000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF; // prettier-ignore uint256 internal constant ASSET_TYPE_MASK = 0xFFFFFFFFFFFFFFFFFFFFF0FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF; // prettier-ignore //uint256 internal constant DYNAMIC_CONFIGS_MASK = 0xFFFFFFFFFFFFFFFFFFFFEFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF; // prettier-ignore /// @dev For the LTV, the start bit is 0 (up to 15), hence no bitshifting is needed uint256 internal constant LIQUIDATION_THRESHOLD_START_BIT_POSITION = 16; uint256 internal constant LIQUIDATION_BONUS_START_BIT_POSITION = 32; uint256 internal constant RESERVE_DECIMALS_START_BIT_POSITION = 48; uint256 internal constant IS_ACTIVE_START_BIT_POSITION = 56; uint256 internal constant IS_FROZEN_START_BIT_POSITION = 57; uint256 internal constant BORROWING_ENABLED_START_BIT_POSITION = 58; uint256 internal constant STABLE_BORROWING_ENABLED_START_BIT_POSITION = 59; uint256 internal constant IS_PAUSED_START_BIT_POSITION = 60; uint256 internal constant SILOED_BORROWING_START_BIT_POSITION = 62; /// @dev bit 63 reserved uint256 internal constant RESERVE_FACTOR_START_BIT_POSITION = 64; uint256 internal constant BORROW_CAP_START_BIT_POSITION = 80; uint256 internal constant SUPPLY_CAP_START_BIT_POSITION = 116; uint256 internal constant LIQUIDATION_PROTOCOL_FEE_START_BIT_POSITION = 152; uint256 internal constant ASSET_TYPE_START_BIT_POSITION = 168; uint256 internal constant MAX_VALID_LTV = 65535; uint256 internal constant MAX_VALID_LIQUIDATION_THRESHOLD = 65535; uint256 internal constant MAX_VALID_LIQUIDATION_BONUS = 65535; uint256 internal constant MAX_VALID_DECIMALS = 255; uint256 internal constant MAX_VALID_RESERVE_FACTOR = 65535; uint256 internal constant MAX_VALID_BORROW_CAP = 68719476735; uint256 internal constant MAX_VALID_SUPPLY_CAP = 68719476735; uint256 internal constant MAX_VALID_LIQUIDATION_PROTOCOL_FEE = 65535; uint256 internal constant MAX_ASSET_TYPE = 16; uint16 public constant MAX_RESERVES_COUNT = 128; /** * @notice Sets the Loan to Value of the reserve * @param self The reserve configuration * @param ltv The new ltv **/ function setLtv(DataTypes.ReserveConfigurationMap memory self, uint256 ltv) internal pure { require(ltv <= MAX_VALID_LTV, Errors.INVALID_LTV); self.data = (self.data & LTV_MASK) | ltv; } /** * @notice Gets the Loan to Value of the reserve * @param self The reserve configuration * @return The loan to value **/ function getLtv(DataTypes.ReserveConfigurationMap memory self) internal pure returns (uint256) { return self.data & ~LTV_MASK; } /** * @notice Sets the liquidation threshold of the reserve * @param self The reserve configuration * @param threshold The new liquidation threshold **/ function setLiquidationThreshold( DataTypes.ReserveConfigurationMap memory self, uint256 threshold ) internal pure { require( threshold <= MAX_VALID_LIQUIDATION_THRESHOLD, Errors.INVALID_LIQ_THRESHOLD ); self.data = (self.data & LIQUIDATION_THRESHOLD_MASK) | (threshold << LIQUIDATION_THRESHOLD_START_BIT_POSITION); } /** * @notice Gets the liquidation threshold of the reserve * @param self The reserve configuration * @return The liquidation threshold **/ function getLiquidationThreshold( DataTypes.ReserveConfigurationMap memory self ) internal pure returns (uint256) { return (self.data & ~LIQUIDATION_THRESHOLD_MASK) >> LIQUIDATION_THRESHOLD_START_BIT_POSITION; } /** * @notice Sets the liquidation bonus of the reserve * @param self The reserve configuration * @param bonus The new liquidation bonus **/ function setLiquidationBonus( DataTypes.ReserveConfigurationMap memory self, uint256 bonus ) internal pure { require(bonus <= MAX_VALID_LIQUIDATION_BONUS, Errors.INVALID_LIQ_BONUS); self.data = (self.data & LIQUIDATION_BONUS_MASK) | (bonus << LIQUIDATION_BONUS_START_BIT_POSITION); } /** * @notice Gets the liquidation bonus of the reserve * @param self The reserve configuration * @return The liquidation bonus **/ function getLiquidationBonus(DataTypes.ReserveConfigurationMap memory self) internal pure returns (uint256) { return (self.data & ~LIQUIDATION_BONUS_MASK) >> LIQUIDATION_BONUS_START_BIT_POSITION; } /** * @notice Sets the decimals of the underlying asset of the reserve * @param self The reserve configuration * @param decimals The decimals **/ function setDecimals( DataTypes.ReserveConfigurationMap memory self, uint256 decimals ) internal pure { require(decimals <= MAX_VALID_DECIMALS, Errors.INVALID_DECIMALS); self.data = (self.data & DECIMALS_MASK) | (decimals << RESERVE_DECIMALS_START_BIT_POSITION); } /** * @notice Gets the decimals of the underlying asset of the reserve * @param self The reserve configuration * @return The decimals of the asset **/ function getDecimals(DataTypes.ReserveConfigurationMap memory self) internal pure returns (uint256) { return (self.data & ~DECIMALS_MASK) >> RESERVE_DECIMALS_START_BIT_POSITION; } /** * @notice Sets the asset type of the reserve * @param self The reserve configuration * @param assetType The asset type **/ function setAssetType( DataTypes.ReserveConfigurationMap memory self, DataTypes.AssetType assetType ) internal pure { require( uint256(assetType) <= MAX_ASSET_TYPE, Errors.INVALID_ASSET_TYPE ); self.data = (self.data & ASSET_TYPE_MASK) | (uint256(assetType) << ASSET_TYPE_START_BIT_POSITION); } /** * @notice Gets the asset type of the reserve * @param self The reserve configuration * @return The asset type **/ function getAssetType(DataTypes.ReserveConfigurationMap memory self) internal pure returns (DataTypes.AssetType) { return DataTypes.AssetType( (self.data & ~ASSET_TYPE_MASK) >> ASSET_TYPE_START_BIT_POSITION ); } /** * @notice Sets the active state of the reserve * @param self The reserve configuration * @param active The active state **/ function setActive( DataTypes.ReserveConfigurationMap memory self, bool active ) internal pure { self.data = (self.data & ACTIVE_MASK) | (uint256(active ? 1 : 0) << IS_ACTIVE_START_BIT_POSITION); } /** * @notice Gets the active state of the reserve * @param self The reserve configuration * @return The active state **/ function getActive(DataTypes.ReserveConfigurationMap memory self) internal pure returns (bool) { return (self.data & ~ACTIVE_MASK) != 0; } /** * @notice Sets the frozen state of the reserve * @param self The reserve configuration * @param frozen The frozen state **/ function setFrozen( DataTypes.ReserveConfigurationMap memory self, bool frozen ) internal pure { self.data = (self.data & FROZEN_MASK) | (uint256(frozen ? 1 : 0) << IS_FROZEN_START_BIT_POSITION); } /** * @notice Gets the frozen state of the reserve * @param self The reserve configuration * @return The frozen state **/ function getFrozen(DataTypes.ReserveConfigurationMap memory self) internal pure returns (bool) { return (self.data & ~FROZEN_MASK) != 0; } /** * @notice Sets the paused state of the reserve * @param self The reserve configuration * @param paused The paused state **/ function setPaused( DataTypes.ReserveConfigurationMap memory self, bool paused ) internal pure { self.data = (self.data & PAUSED_MASK) | (uint256(paused ? 1 : 0) << IS_PAUSED_START_BIT_POSITION); } /** * @notice Gets the paused state of the reserve * @param self The reserve configuration * @return The paused state **/ function getPaused(DataTypes.ReserveConfigurationMap memory self) internal pure returns (bool) { return (self.data & ~PAUSED_MASK) != 0; } /** * @notice Sets the siloed borrowing flag for the reserve. * @dev When this flag is set to true, users borrowing this asset will not be allowed to borrow any other asset. * @param self The reserve configuration * @param siloed True if the asset is siloed **/ function setSiloedBorrowing( DataTypes.ReserveConfigurationMap memory self, bool siloed ) internal pure { self.data = (self.data & SILOED_BORROWING_MASK) | (uint256(siloed ? 1 : 0) << SILOED_BORROWING_START_BIT_POSITION); } /** * @notice Gets the siloed borrowing flag for the reserve. * @dev When this flag is set to true, users borrowing this asset will not be allowed to borrow any other asset. * @param self The reserve configuration * @return The siloed borrowing flag **/ function getSiloedBorrowing(DataTypes.ReserveConfigurationMap memory self) internal pure returns (bool) { return (self.data & ~SILOED_BORROWING_MASK) != 0; } /** * @notice Enables or disables borrowing on the reserve * @param self The reserve configuration * @param enabled True if the borrowing needs to be enabled, false otherwise **/ function setBorrowingEnabled( DataTypes.ReserveConfigurationMap memory self, bool enabled ) internal pure { self.data = (self.data & BORROWING_MASK) | (uint256(enabled ? 1 : 0) << BORROWING_ENABLED_START_BIT_POSITION); } /** * @notice Gets the borrowing state of the reserve * @param self The reserve configuration * @return The borrowing state **/ function getBorrowingEnabled(DataTypes.ReserveConfigurationMap memory self) internal pure returns (bool) { return (self.data & ~BORROWING_MASK) != 0; } /** * @notice Sets the reserve factor of the reserve * @param self The reserve configuration * @param reserveFactor The reserve factor **/ function setReserveFactor( DataTypes.ReserveConfigurationMap memory self, uint256 reserveFactor ) internal pure { require( reserveFactor <= MAX_VALID_RESERVE_FACTOR, Errors.INVALID_RESERVE_FACTOR ); self.data = (self.data & RESERVE_FACTOR_MASK) | (reserveFactor << RESERVE_FACTOR_START_BIT_POSITION); } /** * @notice Gets the reserve factor of the reserve * @param self The reserve configuration * @return The reserve factor **/ function getReserveFactor(DataTypes.ReserveConfigurationMap memory self) internal pure returns (uint256) { return (self.data & ~RESERVE_FACTOR_MASK) >> RESERVE_FACTOR_START_BIT_POSITION; } /** * @notice Sets the borrow cap of the reserve * @param self The reserve configuration * @param borrowCap The borrow cap **/ function setBorrowCap( DataTypes.ReserveConfigurationMap memory self, uint256 borrowCap ) internal pure { require(borrowCap <= MAX_VALID_BORROW_CAP, Errors.INVALID_BORROW_CAP); self.data = (self.data & BORROW_CAP_MASK) | (borrowCap << BORROW_CAP_START_BIT_POSITION); } /** * @notice Gets the borrow cap of the reserve * @param self The reserve configuration * @return The borrow cap **/ function getBorrowCap(DataTypes.ReserveConfigurationMap memory self) internal pure returns (uint256) { return (self.data & ~BORROW_CAP_MASK) >> BORROW_CAP_START_BIT_POSITION; } /** * @notice Sets the supply cap of the reserve * @param self The reserve configuration * @param supplyCap The supply cap **/ function setSupplyCap( DataTypes.ReserveConfigurationMap memory self, uint256 supplyCap ) internal pure { require(supplyCap <= MAX_VALID_SUPPLY_CAP, Errors.INVALID_SUPPLY_CAP); self.data = (self.data & SUPPLY_CAP_MASK) | (supplyCap << SUPPLY_CAP_START_BIT_POSITION); } /** * @notice Gets the supply cap of the reserve * @param self The reserve configuration * @return The supply cap **/ function getSupplyCap(DataTypes.ReserveConfigurationMap memory self) internal pure returns (uint256) { return (self.data & ~SUPPLY_CAP_MASK) >> SUPPLY_CAP_START_BIT_POSITION; } /** * @notice Sets the liquidation protocol fee of the reserve * @param self The reserve configuration * @param liquidationProtocolFee The liquidation protocol fee **/ function setLiquidationProtocolFee( DataTypes.ReserveConfigurationMap memory self, uint256 liquidationProtocolFee ) internal pure { require( liquidationProtocolFee <= MAX_VALID_LIQUIDATION_PROTOCOL_FEE, Errors.INVALID_LIQUIDATION_PROTOCOL_FEE ); self.data = (self.data & LIQUIDATION_PROTOCOL_FEE_MASK) | (liquidationProtocolFee << LIQUIDATION_PROTOCOL_FEE_START_BIT_POSITION); } /** * @dev Gets the liquidation protocol fee * @param self The reserve configuration * @return The liquidation protocol fee **/ function getLiquidationProtocolFee( DataTypes.ReserveConfigurationMap memory self ) internal pure returns (uint256) { return (self.data & ~LIQUIDATION_PROTOCOL_FEE_MASK) >> LIQUIDATION_PROTOCOL_FEE_START_BIT_POSITION; } /** * @notice Gets the configuration flags of the reserve * @param self The reserve configuration * @return The state flag representing active * @return The state flag representing frozen * @return The state flag representing borrowing enabled * @return The state flag representing paused * @return The asset type **/ function getFlags(DataTypes.ReserveConfigurationMap memory self) internal pure returns ( bool, bool, bool, bool, DataTypes.AssetType ) { uint256 dataLocal = self.data; return ( (dataLocal & ~ACTIVE_MASK) != 0, (dataLocal & ~FROZEN_MASK) != 0, (dataLocal & ~BORROWING_MASK) != 0, (dataLocal & ~PAUSED_MASK) != 0, DataTypes.AssetType( (dataLocal & ~ASSET_TYPE_MASK) >> ASSET_TYPE_START_BIT_POSITION ) ); } /** * @notice Gets the configuration parameters of the reserve from storage * @param self The reserve configuration * @return The state param representing ltv * @return The state param representing liquidation threshold * @return The state param representing liquidation bonus * @return The state param representing reserve decimals * @return The state param representing reserve factor **/ function getParams(DataTypes.ReserveConfigurationMap memory self) internal pure returns ( uint256, uint256, uint256, uint256, uint256 ) { uint256 dataLocal = self.data; return ( dataLocal & ~LTV_MASK, (dataLocal & ~LIQUIDATION_THRESHOLD_MASK) >> LIQUIDATION_THRESHOLD_START_BIT_POSITION, (dataLocal & ~LIQUIDATION_BONUS_MASK) >> LIQUIDATION_BONUS_START_BIT_POSITION, (dataLocal & ~DECIMALS_MASK) >> RESERVE_DECIMALS_START_BIT_POSITION, (dataLocal & ~RESERVE_FACTOR_MASK) >> RESERVE_FACTOR_START_BIT_POSITION ); } /** * @notice Gets the caps parameters of the reserve from storage * @param self The reserve configuration * @return The state param representing borrow cap * @return The state param representing supply cap. **/ function getCaps(DataTypes.ReserveConfigurationMap memory self) internal pure returns (uint256, uint256) { uint256 dataLocal = self.data; return ( (dataLocal & ~BORROW_CAP_MASK) >> BORROW_CAP_START_BIT_POSITION, (dataLocal & ~SUPPLY_CAP_MASK) >> SUPPLY_CAP_START_BIT_POSITION ); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.0; import {Errors} from "../helpers/Errors.sol"; import {DataTypes} from "../types/DataTypes.sol"; import {ReserveConfiguration} from "./ReserveConfiguration.sol"; /** * @title UserConfiguration library * * @notice Implements the bitmap logic to handle the user configuration */ library UserConfiguration { using ReserveConfiguration for DataTypes.ReserveConfigurationMap; uint256 internal constant BORROWING_MASK = 0x5555555555555555555555555555555555555555555555555555555555555555; uint256 internal constant COLLATERAL_MASK = 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA; /** * @notice Sets if the user is borrowing the reserve identified by reserveIndex * @param self The configuration object * @param reserveIndex The index of the reserve in the bitmap * @param borrowing True if the user is borrowing the reserve, false otherwise **/ function setBorrowing( DataTypes.UserConfigurationMap storage self, uint256 reserveIndex, bool borrowing ) internal { unchecked { require( reserveIndex < ReserveConfiguration.MAX_RESERVES_COUNT, Errors.INVALID_RESERVE_INDEX ); uint256 bit = 1 << (reserveIndex << 1); if (borrowing) { self.data |= bit; } else { self.data &= ~bit; } } } /** * @notice Sets if the user is using as collateral the reserve identified by reserveIndex * @param self The configuration object * @param reserveIndex The index of the reserve in the bitmap * @param usingAsCollateral True if the user is using the reserve as collateral, false otherwise **/ function setUsingAsCollateral( DataTypes.UserConfigurationMap storage self, uint256 reserveIndex, bool usingAsCollateral ) internal { unchecked { require( reserveIndex < ReserveConfiguration.MAX_RESERVES_COUNT, Errors.INVALID_RESERVE_INDEX ); uint256 bit = 1 << ((reserveIndex << 1) + 1); if (usingAsCollateral) { self.data |= bit; } else { self.data &= ~bit; } } } /** * @notice Returns if a user has been using the reserve for borrowing or as collateral * @param self The configuration object * @param reserveIndex The index of the reserve in the bitmap * @return True if the user has been using a reserve for borrowing or as collateral, false otherwise **/ function isUsingAsCollateralOrBorrowing( DataTypes.UserConfigurationMap memory self, uint256 reserveIndex ) internal pure returns (bool) { unchecked { require( reserveIndex < ReserveConfiguration.MAX_RESERVES_COUNT, Errors.INVALID_RESERVE_INDEX ); return (self.data >> (reserveIndex << 1)) & 3 != 0; } } /** * @notice Validate a user has been using the reserve for borrowing * @param self The configuration object * @param reserveIndex The index of the reserve in the bitmap * @return True if the user has been using a reserve for borrowing, false otherwise **/ function isBorrowing( DataTypes.UserConfigurationMap memory self, uint256 reserveIndex ) internal pure returns (bool) { unchecked { require( reserveIndex < ReserveConfiguration.MAX_RESERVES_COUNT, Errors.INVALID_RESERVE_INDEX ); return (self.data >> (reserveIndex << 1)) & 1 != 0; } } /** * @notice Validate a user has been using the reserve as collateral * @param self The configuration object * @param reserveIndex The index of the reserve in the bitmap * @return True if the user has been using a reserve as collateral, false otherwise **/ function isUsingAsCollateral( DataTypes.UserConfigurationMap memory self, uint256 reserveIndex ) internal pure returns (bool) { unchecked { require( reserveIndex < ReserveConfiguration.MAX_RESERVES_COUNT, Errors.INVALID_RESERVE_INDEX ); return (self.data >> ((reserveIndex << 1) + 1)) & 1 != 0; } } /** * @notice Checks if a user has been supplying only one reserve as collateral * @dev this uses a simple trick - if a number is a power of two (only one bit set) then n & (n - 1) == 0 * @param self The configuration object * @return True if the user has been supplying as collateral one reserve, false otherwise **/ function isUsingAsCollateralOne(DataTypes.UserConfigurationMap memory self) internal pure returns (bool) { uint256 collateralData = self.data & COLLATERAL_MASK; return collateralData != 0 && (collateralData & (collateralData - 1) == 0); } /** * @notice Checks if a user has been supplying any reserve as collateral * @param self The configuration object * @return True if the user has been supplying as collateral any reserve, false otherwise **/ function isUsingAsCollateralAny(DataTypes.UserConfigurationMap memory self) internal pure returns (bool) { return self.data & COLLATERAL_MASK != 0; } /** * @notice Checks if a user has been borrowing only one asset * @dev this uses a simple trick - if a number is a power of two (only one bit set) then n & (n - 1) == 0 * @param self The configuration object * @return True if the user has been supplying as collateral one reserve, false otherwise **/ function isBorrowingOne(DataTypes.UserConfigurationMap memory self) internal pure returns (bool) { uint256 borrowingData = self.data & BORROWING_MASK; return borrowingData != 0 && (borrowingData & (borrowingData - 1) == 0); } /** * @notice Checks if a user has been borrowing from any reserve * @param self The configuration object * @return True if the user has been borrowing any reserve, false otherwise **/ function isBorrowingAny(DataTypes.UserConfigurationMap memory self) internal pure returns (bool) { return self.data & BORROWING_MASK != 0; } /** * @notice Checks if a user has not been using any reserve for borrowing or supply * @param self The configuration object * @return True if the user has not been borrowing or supplying any reserve, false otherwise **/ function isEmpty(DataTypes.UserConfigurationMap memory self) internal pure returns (bool) { return self.data == 0; } /** * @notice Returns the siloed borrowing state for the user * @param self The configuration object * @param reservesData The data of all the reserves * @param reservesList The reserve list * @return True if the user has borrowed a siloed asset, false otherwise * @return The address of the only borrowed asset */ function getSiloedBorrowingState( DataTypes.UserConfigurationMap memory self, mapping(address => DataTypes.ReserveData) storage reservesData, mapping(uint256 => address) storage reservesList ) internal view returns (bool, address) { if (isBorrowingOne(self)) { uint256 assetId = _getFirstAssetIdByMask(self, BORROWING_MASK); address assetAddress = reservesList[assetId]; if (reservesData[assetAddress].configuration.getSiloedBorrowing()) { return (true, assetAddress); } } return (false, address(0)); } /** * @notice Returns the address of the first asset flagged in the bitmap given the corresponding bitmask * @param self The configuration object * @return The index of the first asset flagged in the bitmap once the corresponding mask is applied */ function _getFirstAssetIdByMask( DataTypes.UserConfigurationMap memory self, uint256 mask ) internal pure returns (uint256) { unchecked { uint256 bitmapData = self.data & mask; uint256 firstAssetPosition = bitmapData & ~(bitmapData - 1); uint256 id; while ((firstAssetPosition >>= 2) != 0) { id += 1; } return id; } } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.0; /** * @title Errors library * * @notice Defines the error messages emitted by the different contracts of the ParaSpace protocol */ library Errors { string public constant CALLER_NOT_POOL_ADMIN = "1"; // 'The caller of the function is not a pool admin' string public constant CALLER_NOT_EMERGENCY_ADMIN = "2"; // 'The caller of the function is not an emergency admin' string public constant CALLER_NOT_POOL_OR_EMERGENCY_ADMIN = "3"; // 'The caller of the function is not a pool or emergency admin' string public constant CALLER_NOT_RISK_OR_POOL_ADMIN = "4"; // 'The caller of the function is not a risk or pool admin' string public constant CALLER_NOT_ASSET_LISTING_OR_POOL_ADMIN = "5"; // 'The caller of the function is not an asset listing or pool admin' string public constant CALLER_NOT_BRIDGE = "6"; // 'The caller of the function is not a bridge' string public constant ADDRESSES_PROVIDER_NOT_REGISTERED = "7"; // 'Pool addresses provider is not registered' string public constant INVALID_ADDRESSES_PROVIDER_ID = "8"; // 'Invalid id for the pool addresses provider' string public constant NOT_CONTRACT = "9"; // 'Address is not a contract' string public constant CALLER_NOT_POOL_CONFIGURATOR = "10"; // 'The caller of the function is not the pool configurator' string public constant CALLER_NOT_XTOKEN = "11"; // 'The caller of the function is not an PToken or NToken' string public constant INVALID_ADDRESSES_PROVIDER = "12"; // 'The address of the pool addresses provider is invalid' string public constant RESERVE_ALREADY_ADDED = "14"; // 'Reserve has already been added to reserve list' string public constant NO_MORE_RESERVES_ALLOWED = "15"; // 'Maximum amount of reserves in the pool reached' string public constant RESERVE_LIQUIDITY_NOT_ZERO = "18"; // 'The liquidity of the reserve needs to be 0' string public constant INVALID_RESERVE_PARAMS = "20"; // 'Invalid risk parameters for the reserve' string public constant CALLER_MUST_BE_POOL = "23"; // 'The caller of this function must be a pool' string public constant INVALID_MINT_AMOUNT = "24"; // 'Invalid amount to mint' string public constant INVALID_BURN_AMOUNT = "25"; // 'Invalid amount to burn' string public constant INVALID_AMOUNT = "26"; // 'Amount must be greater than 0' string public constant RESERVE_INACTIVE = "27"; // 'Action requires an active reserve' string public constant RESERVE_FROZEN = "28"; // 'Action cannot be performed because the reserve is frozen' string public constant RESERVE_PAUSED = "29"; // 'Action cannot be performed because the reserve is paused' string public constant BORROWING_NOT_ENABLED = "30"; // 'Borrowing is not enabled' string public constant STABLE_BORROWING_NOT_ENABLED = "31"; // 'Stable borrowing is not enabled' string public constant NOT_ENOUGH_AVAILABLE_USER_BALANCE = "32"; // 'User cannot withdraw more than the available balance' string public constant INVALID_INTEREST_RATE_MODE_SELECTED = "33"; // 'Invalid interest rate mode selected' string public constant COLLATERAL_BALANCE_IS_ZERO = "34"; // 'The collateral balance is 0' string public constant HEALTH_FACTOR_LOWER_THAN_LIQUIDATION_THRESHOLD = "35"; // 'Health factor is lesser than the liquidation threshold' string public constant COLLATERAL_CANNOT_COVER_NEW_BORROW = "36"; // 'There is not enough collateral to cover a new borrow' string public constant COLLATERAL_SAME_AS_BORROWING_CURRENCY = "37"; // 'Collateral is (mostly) the same currency that is being borrowed' string public constant AMOUNT_BIGGER_THAN_MAX_LOAN_SIZE_STABLE = "38"; // 'The requested amount is greater than the max loan size in stable rate mode' string public constant NO_DEBT_OF_SELECTED_TYPE = "39"; // 'For repayment of a specific type of debt, the user needs to have debt that type' string public constant NO_EXPLICIT_AMOUNT_TO_REPAY_ON_BEHALF = "40"; // 'To repay on behalf of a user an explicit amount to repay is needed' string public constant NO_OUTSTANDING_STABLE_DEBT = "41"; // 'User does not have outstanding stable rate debt on this reserve' string public constant NO_OUTSTANDING_VARIABLE_DEBT = "42"; // 'User does not have outstanding variable rate debt on this reserve' string public constant UNDERLYING_BALANCE_ZERO = "43"; // 'The underlying balance needs to be greater than 0' string public constant INTEREST_RATE_REBALANCE_CONDITIONS_NOT_MET = "44"; // 'Interest rate rebalance conditions were not met' string public constant HEALTH_FACTOR_NOT_BELOW_THRESHOLD = "45"; // 'Health factor is not below the threshold' string public constant COLLATERAL_CANNOT_BE_AUCTIONED_OR_LIQUIDATED = "46"; // 'The collateral chosen cannot be auctioned OR liquidated' string public constant SPECIFIED_CURRENCY_NOT_BORROWED_BY_USER = "47"; // 'User did not borrow the specified currency' string public constant SAME_BLOCK_BORROW_REPAY = "48"; // 'Borrow and repay in same block is not allowed' string public constant BORROW_CAP_EXCEEDED = "50"; // 'Borrow cap is exceeded' string public constant SUPPLY_CAP_EXCEEDED = "51"; // 'Supply cap is exceeded' string public constant XTOKEN_SUPPLY_NOT_ZERO = "54"; // 'PToken supply is not zero' string public constant STABLE_DEBT_NOT_ZERO = "55"; // 'Stable debt supply is not zero' string public constant VARIABLE_DEBT_SUPPLY_NOT_ZERO = "56"; // 'Variable debt supply is not zero' string public constant LTV_VALIDATION_FAILED = "57"; // 'Ltv validation failed' string public constant PRICE_ORACLE_SENTINEL_CHECK_FAILED = "59"; // 'Price oracle sentinel validation failed' string public constant RESERVE_ALREADY_INITIALIZED = "61"; // 'Reserve has already been initialized' string public constant INVALID_LTV = "63"; // 'Invalid ltv parameter for the reserve' string public constant INVALID_LIQ_THRESHOLD = "64"; // 'Invalid liquidity threshold parameter for the reserve' string public constant INVALID_LIQ_BONUS = "65"; // 'Invalid liquidity bonus parameter for the reserve' string public constant INVALID_DECIMALS = "66"; // 'Invalid decimals parameter of the underlying asset of the reserve' string public constant INVALID_RESERVE_FACTOR = "67"; // 'Invalid reserve factor parameter for the reserve' string public constant INVALID_BORROW_CAP = "68"; // 'Invalid borrow cap for the reserve' string public constant INVALID_SUPPLY_CAP = "69"; // 'Invalid supply cap for the reserve' string public constant INVALID_LIQUIDATION_PROTOCOL_FEE = "70"; // 'Invalid liquidation protocol fee for the reserve' string public constant INVALID_DEBT_CEILING = "73"; // 'Invalid debt ceiling for the reserve string public constant INVALID_RESERVE_INDEX = "74"; // 'Invalid reserve index' string public constant ACL_ADMIN_CANNOT_BE_ZERO = "75"; // 'ACL admin cannot be set to the zero address' string public constant INCONSISTENT_PARAMS_LENGTH = "76"; // 'Array parameters that should be equal length are not' string public constant ZERO_ADDRESS_NOT_VALID = "77"; // 'Zero address not valid' string public constant INVALID_EXPIRATION = "78"; // 'Invalid expiration' string public constant INVALID_SIGNATURE = "79"; // 'Invalid signature' string public constant OPERATION_NOT_SUPPORTED = "80"; // 'Operation not supported' string public constant ASSET_NOT_LISTED = "82"; // 'Asset is not listed' string public constant INVALID_OPTIMAL_USAGE_RATIO = "83"; // 'Invalid optimal usage ratio' string public constant INVALID_OPTIMAL_STABLE_TO_TOTAL_DEBT_RATIO = "84"; // 'Invalid optimal stable to total debt ratio' string public constant UNDERLYING_CANNOT_BE_RESCUED = "85"; // 'The underlying asset cannot be rescued' string public constant ADDRESSES_PROVIDER_ALREADY_ADDED = "86"; // 'Reserve has already been added to reserve list' string public constant POOL_ADDRESSES_DO_NOT_MATCH = "87"; // 'The token implementation pool address and the pool address provided by the initializing pool do not match' string public constant STABLE_BORROWING_ENABLED = "88"; // 'Stable borrowing is enabled' string public constant SILOED_BORROWING_VIOLATION = "89"; // 'User is trying to borrow multiple assets including a siloed one' string public constant RESERVE_DEBT_NOT_ZERO = "90"; // the total debt of the reserve needs to be 0 string public constant NOT_THE_OWNER = "91"; // user is not the owner of a given asset string public constant LIQUIDATION_AMOUNT_NOT_ENOUGH = "92"; string public constant INVALID_ASSET_TYPE = "93"; // invalid asset type for action. string public constant INVALID_FLASH_CLAIM_RECEIVER = "94"; // invalid flash claim receiver. string public constant ERC721_HEALTH_FACTOR_NOT_BELOW_THRESHOLD = "95"; // ERC721 Health factor is not below the threshold. Can only liquidate ERC20. string public constant UNDERLYING_ASSET_CAN_NOT_BE_TRANSFERRED = "96"; //underlying asset can not be transferred. string public constant TOKEN_TRANSFERRED_CAN_NOT_BE_SELF_ADDRESS = "97"; //token transferred can not be self address. string public constant INVALID_AIRDROP_CONTRACT_ADDRESS = "98"; //invalid airdrop contract address. string public constant INVALID_AIRDROP_PARAMETERS = "99"; //invalid airdrop parameters. string public constant CALL_AIRDROP_METHOD_FAILED = "100"; //call airdrop method failed. string public constant SUPPLIER_NOT_NTOKEN = "101"; //supplier is not the NToken contract string public constant CALL_MARKETPLACE_FAILED = "102"; //call marketplace failed. string public constant INVALID_MARKETPLACE_ID = "103"; //invalid marketplace id. string public constant INVALID_MARKETPLACE_ORDER = "104"; //invalid marketplace id. string public constant CREDIT_DOES_NOT_MATCH_ORDER = "105"; //credit doesn't match order. string public constant PAYNOW_NOT_ENOUGH = "106"; //paynow not enough. string public constant INVALID_CREDIT_SIGNATURE = "107"; //invalid credit signature. string public constant INVALID_ORDER_TAKER = "108"; //invalid order taker. string public constant MARKETPLACE_PAUSED = "109"; //marketplace paused. string public constant INVALID_AUCTION_RECOVERY_HEALTH_FACTOR = "110"; //invalid auction recovery health factor. string public constant AUCTION_ALREADY_STARTED = "111"; //auction already started. string public constant AUCTION_NOT_STARTED = "112"; //auction not started yet. string public constant AUCTION_NOT_ENABLED = "113"; //auction not enabled on the reserve. string public constant ERC721_HEALTH_FACTOR_NOT_ABOVE_THRESHOLD = "114"; //ERC721 Health factor is not above the threshold. string public constant TOKEN_IN_AUCTION = "115"; //tokenId is in auction. string public constant AUCTIONED_BALANCE_NOT_ZERO = "116"; //auctioned balance not zero. string public constant LIQUIDATOR_CAN_NOT_BE_SELF = "117"; //user can not liquidate himself. string public constant INVALID_RECIPIENT = "118"; //invalid recipient specified in order. string public constant FLASHCLAIM_NOT_ALLOWED = "119"; //flash claim is not allowed for UniswapV3 & Stakefish string public constant NTOKEN_BALANCE_EXCEEDED = "120"; //ntoken balance exceed limit. string public constant ORACLE_PRICE_NOT_READY = "121"; //oracle price not ready. string public constant SET_ORACLE_SOURCE_NOT_ALLOWED = "122"; //source of oracle not allowed to set. string public constant INVALID_LIQUIDATION_ASSET = "123"; //invalid liquidation asset. string public constant XTOKEN_TYPE_NOT_ALLOWED = "124"; //the corresponding xTokenType not allowed in this action string public constant GLOBAL_DEBT_IS_ZERO = "125"; //liquidation is not allowed when global debt is zero. string public constant ORACLE_PRICE_EXPIRED = "126"; //oracle price expired. string public constant APE_STAKING_POSITION_EXISTED = "127"; //ape staking position is existed. string public constant SAPE_NOT_ALLOWED = "128"; //operation is not allow for sApe. string public constant TOTAL_STAKING_AMOUNT_WRONG = "129"; //cash plus borrow amount not equal to total staking amount. string public constant NOT_THE_BAKC_OWNER = "130"; //user is not the bakc owner. string public constant CALLER_NOT_EOA = "131"; //The caller of the function is not an EOA account string public constant MAKER_SAME_AS_TAKER = "132"; //maker and taker shouldn't be the same address string public constant TOKEN_ALREADY_DELEGATED = "133"; //token is already delegted string public constant INVALID_STATE = "134"; //invalid token status string public constant INVALID_TOKEN_ID = "135"; //invalid token id string public constant SENDER_SAME_AS_RECEIVER = "136"; //sender and receiver shouldn't be the same address string public constant INVALID_YIELD_UNDERLYING_TOKEN = "137"; //invalid yield underlying token string public constant CALLER_NOT_OPERATOR = "138"; // The caller of the function is not operator string public constant INVALID_FEE_VALUE = "139"; // invalid fee rate value string public constant TOKEN_NOT_ALLOW_RESCUE = "140"; // token is not allow rescue }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.0; import {IERC20} from "../../../dependencies/openzeppelin/contracts/IERC20.sol"; import {DataTypes} from "../types/DataTypes.sol"; import {WadRayMath} from "../../libraries/math/WadRayMath.sol"; import {IAtomicCollateralizableERC721} from "../../../interfaces/IAtomicCollateralizableERC721.sol"; import {UserConfiguration} from "../configuration/UserConfiguration.sol"; /** * @title Helpers library * */ library Helpers { using WadRayMath for uint256; using UserConfiguration for DataTypes.UserConfigurationMap; // See `IPool` for descriptions event ReserveUsedAsCollateralEnabled( address indexed reserve, address indexed user ); /** * @notice Fetches the user current stable and variable debt balances * @param user The user address * @param debtTokenAddress The debt token address * @return The variable debt balance **/ function getUserCurrentDebt(address user, address debtTokenAddress) internal view returns (uint256) { return (IERC20(debtTokenAddress).balanceOf(user)); } function getTraitBoostedTokenPrice( address xTokenAddress, uint256 assetPrice, uint256 tokenId ) internal view returns (uint256) { uint256 multiplier = IAtomicCollateralizableERC721(xTokenAddress) .getTraitMultiplier(tokenId); return assetPrice.wadMul(multiplier); } /** * @dev transfer ETH to an address, revert if it fails. * @param to recipient of the transfer * @param value the amount to send */ function safeTransferETH(address to, uint256 value) internal { (bool success, ) = to.call{value: value}(new bytes(0)); require(success, "ETH_TRANSFER_FAILED"); } /** * @notice Set user's collateral status for specified asset, if current collateral status is true, skip it. * @param userConfig The user configuration mapping that tracks the supplied/borrowed assets * @param reservesData The state of all the reserves * @param token The asset address * @param user The user address **/ function setAssetUsedAsCollateral( DataTypes.UserConfigurationMap storage userConfig, mapping(address => DataTypes.ReserveData) storage reservesData, address token, address user ) internal { uint16 reserveId = reservesData[token].id; bool currentStatus = userConfig.isUsingAsCollateral(reserveId); if (!currentStatus) { userConfig.setUsingAsCollateral(reserveId, true); emit ReserveUsedAsCollateralEnabled(token, user); } } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.0; /** * @title WadRayMath library * * @notice Provides functions to perform calculations with Wad and Ray units * @dev Provides mul and div function for wads (decimal numbers with 18 digits of precision) and rays (decimal numbers * with 27 digits of precision) * @dev Operations are rounded. If a value is >=.5, will be rounded up, otherwise rounded down. **/ library WadRayMath { // HALF_WAD and HALF_RAY expressed with extended notation as constant with operations are not supported in Yul assembly uint256 internal constant WAD = 1e18; uint256 internal constant HALF_WAD = 0.5e18; uint256 internal constant RAY = 1e27; uint256 internal constant HALF_RAY = 0.5e27; uint256 internal constant WAD_RAY_RATIO = 1e9; /** * @dev Multiplies two wad, rounding half up to the nearest wad * @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328 * @param a Wad * @param b Wad * @return c = a*b, in wad **/ function wadMul(uint256 a, uint256 b) internal pure returns (uint256 c) { // to avoid overflow, a <= (type(uint256).max - HALF_WAD) / b assembly { if iszero( or(iszero(b), iszero(gt(a, div(sub(not(0), HALF_WAD), b)))) ) { revert(0, 0) } c := div(add(mul(a, b), HALF_WAD), WAD) } } /** * @dev Divides two wad, rounding half up to the nearest wad * @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328 * @param a Wad * @param b Wad * @return c = a/b, in wad **/ function wadDiv(uint256 a, uint256 b) internal pure returns (uint256 c) { // to avoid overflow, a <= (type(uint256).max - halfB) / WAD assembly { if or( iszero(b), iszero(iszero(gt(a, div(sub(not(0), div(b, 2)), WAD)))) ) { revert(0, 0) } c := div(add(mul(a, WAD), div(b, 2)), b) } } /** * @notice Multiplies two ray, rounding half up to the nearest ray * @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328 * @param a Ray * @param b Ray * @return c = a raymul b **/ function rayMul(uint256 a, uint256 b) internal pure returns (uint256 c) { // to avoid overflow, a <= (type(uint256).max - HALF_RAY) / b assembly { if iszero( or(iszero(b), iszero(gt(a, div(sub(not(0), HALF_RAY), b)))) ) { revert(0, 0) } c := div(add(mul(a, b), HALF_RAY), RAY) } } /** * @notice Divides two ray, rounding half up to the nearest ray * @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328 * @param a Ray * @param b Ray * @return c = a raydiv b **/ function rayDiv(uint256 a, uint256 b) internal pure returns (uint256 c) { // to avoid overflow, a <= (type(uint256).max - halfB) / RAY assembly { if or( iszero(b), iszero(iszero(gt(a, div(sub(not(0), div(b, 2)), RAY)))) ) { revert(0, 0) } c := div(add(mul(a, RAY), div(b, 2)), b) } } /** * @dev Casts ray down to wad * @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328 * @param a Ray * @return b = a converted to wad, rounded half up to the nearest wad **/ function rayToWad(uint256 a) internal pure returns (uint256 b) { assembly { b := div(a, WAD_RAY_RATIO) let remainder := mod(a, WAD_RAY_RATIO) if iszero(lt(remainder, div(WAD_RAY_RATIO, 2))) { b := add(b, 1) } } } /** * @dev Converts wad up to ray * @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328 * @param a Wad * @return b = a converted in ray **/ function wadToRay(uint256 a) internal pure returns (uint256 b) { // to avoid overflow, b/WAD_RAY_RATIO == a assembly { b := mul(a, WAD_RAY_RATIO) if iszero(eq(div(b, WAD_RAY_RATIO), a)) { revert(0, 0) } } } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.0; import {OfferItem, ConsiderationItem} from "../../../dependencies/seaport/contracts/lib/ConsiderationStructs.sol"; import {IStakefishValidator} from "../../../interfaces/IStakefishValidator.sol"; library DataTypes { enum AssetType { ERC20, ERC721 } address public constant SApeAddress = address(0x1); uint256 public constant HEALTH_FACTOR_LIQUIDATION_THRESHOLD = 1e18; struct ReserveData { //stores the reserve configuration ReserveConfigurationMap configuration; //the liquidity index. Expressed in ray uint128 liquidityIndex; //the current supply rate. Expressed in ray uint128 currentLiquidityRate; //variable borrow index. Expressed in ray uint128 variableBorrowIndex; //the current variable borrow rate. Expressed in ray uint128 currentVariableBorrowRate; //timestamp of last update uint40 lastUpdateTimestamp; //the id of the reserve. Represents the position in the list of the active reserves uint16 id; //xToken address address xTokenAddress; //variableDebtToken address address variableDebtTokenAddress; //address of the interest rate strategy address interestRateStrategyAddress; //address of the auction strategy address auctionStrategyAddress; //the current treasury balance, scaled uint128 accruedToTreasury; // timelock strategy address timeLockStrategyAddress; // use uint128 to be used for crosschain in the future // after position move uint128 unbacked; } struct ReserveConfigurationMap { //bit 0-15: LTV //bit 16-31: Liq. threshold //bit 32-47: Liq. bonus //bit 48-55: Decimals //bit 56: reserve is active //bit 57: reserve is frozen //bit 58: borrowing is enabled //bit 59: stable rate borrowing enabled //bit 60: asset is paused //bit 61: borrowing in isolation mode is enabled //bit 62-63: reserved //bit 64-79: reserve factor //bit 80-115 borrow cap in whole tokens, borrowCap == 0 => no cap //bit 116-151 supply cap in whole tokens, supplyCap == 0 => no cap //bit 152-167 liquidation protocol fee //bit 168-175 eMode category //bit 176-211 unbacked mint cap in whole tokens, unbackedMintCap == 0 => minting disabled //bit 212-251 debt ceiling for isolation mode with (ReserveConfiguration::DEBT_CEILING_DECIMALS) decimals //bit 252-255 unused uint256 data; } struct UserConfigurationMap { /** * @dev Bitmap of the users collaterals and borrows. It is divided in pairs of bits, one pair per asset. * The first bit indicates if an asset is used as collateral by the user, the second whether an * asset is borrowed by the user. */ uint256 data; // auction validity time for closing invalid auctions in one tx. uint256 auctionValidityTime; } struct ERC721SupplyParams { uint256 tokenId; bool useAsCollateral; } struct StakefishNTokenData { uint256 validatorIndex; bytes pubkey; uint256 withdrawnBalance; address feePoolAddress; string nftArtUrl; uint256 protocolFee; IStakefishValidator.StateChange[] stateHistory; uint256[2] pendingFeePoolReward; } struct NTokenData { uint256 tokenId; uint256 multiplier; bool useAsCollateral; bool isAuctioned; StakefishNTokenData stakefishNTokenData; } struct ReserveCache { uint256 currScaledVariableDebt; uint256 nextScaledVariableDebt; uint256 currLiquidityIndex; uint256 nextLiquidityIndex; uint256 currVariableBorrowIndex; uint256 nextVariableBorrowIndex; uint256 currLiquidityRate; uint256 currVariableBorrowRate; uint256 reserveFactor; ReserveConfigurationMap reserveConfiguration; address xTokenAddress; address variableDebtTokenAddress; uint40 reserveLastUpdateTimestamp; } struct ExecuteLiquidateParams { uint256 reservesCount; uint256 liquidationAmount; uint256 collateralTokenId; uint256 auctionRecoveryHealthFactor; address weth; address collateralAsset; address liquidationAsset; address borrower; address liquidator; bool receiveXToken; address priceOracle; address priceOracleSentinel; } struct ExecuteAuctionParams { uint256 reservesCount; uint256 auctionRecoveryHealthFactor; uint256 collateralTokenId; address collateralAsset; address user; address priceOracle; } struct ExecuteSupplyParams { address asset; uint256 amount; address onBehalfOf; address payer; uint16 referralCode; } struct ExecuteSupplyERC721Params { address asset; DataTypes.ERC721SupplyParams[] tokenData; address onBehalfOf; address payer; uint16 referralCode; } struct ExecuteBorrowParams { address asset; address user; address onBehalfOf; uint256 amount; uint16 referralCode; bool releaseUnderlying; uint256 reservesCount; address oracle; address priceOracleSentinel; } struct ExecuteRepayParams { address asset; uint256 amount; address onBehalfOf; address payer; bool usePTokens; } struct ExecuteWithdrawParams { address asset; uint256 amount; address to; uint256 reservesCount; address oracle; } struct ExecuteWithdrawERC721Params { address asset; uint256[] tokenIds; address to; uint256 reservesCount; address oracle; } struct ExecuteDecreaseUniswapV3LiquidityParams { address user; address asset; uint256 tokenId; uint256 reservesCount; uint128 liquidityDecrease; uint256 amount0Min; uint256 amount1Min; bool receiveEthAsWeth; address oracle; } struct FinalizeTransferParams { address asset; address from; address to; bool usedAsCollateral; uint256 amount; uint256 balanceFromBefore; uint256 balanceToBefore; uint256 reservesCount; address oracle; } struct FinalizeTransferERC721Params { address asset; address from; address to; bool usedAsCollateral; uint256 tokenId; uint256 balanceFromBefore; uint256 reservesCount; address oracle; } struct CalculateUserAccountDataParams { UserConfigurationMap userConfig; uint256 reservesCount; address user; address oracle; } struct ValidateBorrowParams { ReserveCache reserveCache; UserConfigurationMap userConfig; address asset; address userAddress; uint256 amount; uint256 reservesCount; address oracle; address priceOracleSentinel; } struct ValidateLiquidateERC20Params { ReserveCache liquidationAssetReserveCache; address liquidationAsset; address weth; uint256 totalDebt; uint256 healthFactor; uint256 liquidationAmount; uint256 actualLiquidationAmount; address priceOracleSentinel; } struct ValidateLiquidateERC721Params { ReserveCache liquidationAssetReserveCache; address liquidationAsset; address liquidator; address borrower; uint256 globalDebt; uint256 healthFactor; address collateralAsset; uint256 tokenId; address weth; uint256 actualLiquidationAmount; uint256 maxLiquidationAmount; uint256 auctionRecoveryHealthFactor; address priceOracleSentinel; address xTokenAddress; bool auctionEnabled; } struct ValidateAuctionParams { address user; uint256 auctionRecoveryHealthFactor; uint256 erc721HealthFactor; address collateralAsset; uint256 tokenId; address xTokenAddress; } struct CalculateInterestRatesParams { uint256 liquidityAdded; uint256 liquidityTaken; uint256 totalVariableDebt; uint256 reserveFactor; address reserve; address xToken; } struct InitReserveParams { address asset; address xTokenAddress; address variableDebtAddress; address interestRateStrategyAddress; address auctionStrategyAddress; address timeLockStrategyAddress; uint16 reservesCount; uint16 maxNumberReserves; } struct ExecuteFlashClaimParams { address receiverAddress; address[] nftAssets; uint256[][] nftTokenIds; bytes params; address oracle; } struct Credit { address token; uint256 amount; bytes orderId; uint8 v; bytes32 r; bytes32 s; } struct ExecuteMarketplaceParams { bytes32 marketplaceId; bytes payload; Credit credit; uint256 ethLeft; DataTypes.Marketplace marketplace; OrderInfo orderInfo; address weth; uint16 referralCode; uint256 reservesCount; address oracle; address priceOracleSentinel; } struct OrderInfo { address maker; address taker; bytes id; OfferItem[] offer; ConsiderationItem[] consideration; } struct Marketplace { address marketplace; address adapter; address operator; bool paused; } struct Auction { uint256 startTime; } struct AuctionData { address asset; uint256 tokenId; uint256 startTime; uint256 currentPriceMultiplier; uint256 maxPriceMultiplier; uint256 minExpPriceMultiplier; uint256 minPriceMultiplier; uint256 stepLinear; uint256 stepExp; uint256 tickLength; } struct TokenData { string symbol; address tokenAddress; } enum ApeCompoundType { SwapAndSupply } enum ApeCompoundTokenOut { USDC, WETH } struct ApeCompoundStrategy { ApeCompoundType ty; ApeCompoundTokenOut swapTokenOut; uint256 swapPercent; } struct PoolStorage { // Map of reserves and their data (underlyingAssetOfReserve => reserveData) mapping(address => ReserveData) _reserves; // Map of users address and their configuration data (userAddress => userConfiguration) mapping(address => UserConfigurationMap) _usersConfig; // List of reserves as a map (reserveId => reserve). // It is structured as a mapping for gas savings reasons, using the reserve id as index mapping(uint256 => address) _reservesList; // Maximum number of active reserves there have been in the protocol. It is the upper bound of the reserves list uint16 _reservesCount; // Auction recovery health factor uint64 _auctionRecoveryHealthFactor; // Incentive fee for claim ape reward to compound uint16 _apeCompoundFee; // Map of user's ape compound strategies mapping(address => ApeCompoundStrategy) _apeCompoundStrategies; } struct ReserveConfigData { uint256 decimals; uint256 ltv; uint256 liquidationThreshold; uint256 liquidationBonus; uint256 reserveFactor; bool usageAsCollateralEnabled; bool borrowingEnabled; bool isActive; bool isFrozen; bool isPaused; } struct TimeLockParams { uint48 releaseTime; TimeLockActionType actionType; } struct TimeLockFactorParams { AssetType assetType; address asset; uint256 amount; } enum TimeLockActionType { BORROW, WITHDRAW } struct ParaSpacePositionMoveInfo { address[] cTokens; DataTypes.AssetType[] cTypes; uint256[][] cAmountsOrTokenIds; address[] dTokens; uint256[] dAmounts; address to; } struct ParaSpacePositionMoveParams { address user; address[] cTokens; DataTypes.AssetType[] cTypes; uint256[][] cAmountsOrTokenIds; address[] dTokens; uint256[] dAmounts; address to; address priceOracle; address priceOracleSentinel; uint256 reservesCount; } }
{ "remappings": [ "contracts/=contracts/", "ds-test/=lib/ds-test/src/", "forge-std/=lib/forge-std/src/", "pnm-contracts/=lib/pnm-contracts/" ], "optimizer": { "enabled": true, "runs": 200 }, "metadata": { "bytecodeHash": "ipfs" }, "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } }, "evmVersion": "london", "libraries": {} }
Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
[{"inputs":[{"internalType":"contract IPoolAddressesProvider","name":"provider","type":"address"},{"internalType":"address","name":"_wpunk","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"agreementId","type":"uint256"},{"indexed":false,"internalType":"enum DataTypes.AssetType","name":"assetType","type":"uint8"},{"indexed":false,"internalType":"enum DataTypes.TimeLockActionType","name":"actionType","type":"uint8"},{"indexed":true,"internalType":"address","name":"asset","type":"address"},{"indexed":false,"internalType":"uint256[]","name":"tokenIdsOrAmounts","type":"uint256[]"},{"indexed":true,"internalType":"address","name":"beneficiary","type":"address"}],"name":"AgreementClaimed","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"agreementId","type":"uint256"},{"indexed":false,"internalType":"enum DataTypes.AssetType","name":"assetType","type":"uint8"},{"indexed":false,"internalType":"enum DataTypes.TimeLockActionType","name":"actionType","type":"uint8"},{"indexed":true,"internalType":"address","name":"asset","type":"address"},{"indexed":false,"internalType":"uint256[]","name":"tokenIdsOrAmounts","type":"uint256[]"},{"indexed":true,"internalType":"address","name":"beneficiary","type":"address"},{"indexed":false,"internalType":"uint48","name":"releaseTime","type":"uint48"}],"name":"AgreementCreated","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"agreementId","type":"uint256"},{"indexed":false,"internalType":"bool","name":"value","type":"bool"}],"name":"AgreementFrozen","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint8","name":"version","type":"uint8"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"bool","name":"value","type":"bool"}],"name":"TimeLockFrozen","type":"event"},{"inputs":[],"name":"agreementCount","outputs":[{"internalType":"uint248","name":"","type":"uint248"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"agreementIds","type":"uint256[]"}],"name":"claim","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"agreementIds","type":"uint256[]"}],"name":"claimETH","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"agreementIds","type":"uint256[]"}],"name":"claimMoonBirds","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"agreementIds","type":"uint256[]"}],"name":"claimPunk","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"enum DataTypes.AssetType","name":"assetType","type":"uint8"},{"internalType":"enum DataTypes.TimeLockActionType","name":"actionType","type":"uint8"},{"internalType":"address","name":"asset","type":"address"},{"internalType":"uint256[]","name":"tokenIdsOrAmounts","type":"uint256[]"},{"internalType":"address","name":"beneficiary","type":"address"},{"internalType":"uint48","name":"releaseTime","type":"uint48"}],"name":"createAgreement","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"agreementId","type":"uint256"}],"name":"freezeAgreement","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"freezeAllAgreements","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"frozen","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"agreementId","type":"uint256"}],"name":"getAgreement","outputs":[{"components":[{"internalType":"enum DataTypes.AssetType","name":"assetType","type":"uint8"},{"internalType":"enum DataTypes.TimeLockActionType","name":"actionType","type":"uint8"},{"internalType":"bool","name":"isFrozen","type":"bool"},{"internalType":"address","name":"asset","type":"address"},{"internalType":"address","name":"beneficiary","type":"address"},{"internalType":"uint48","name":"releaseTime","type":"uint48"},{"internalType":"uint256[]","name":"tokenIdsOrAmounts","type":"uint256[]"}],"internalType":"struct ITimeLock.Agreement","name":"agreement","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC721Received","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"agreementId","type":"uint256"}],"name":"unfreezeAgreement","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"unfreezeAllAgreements","outputs":[],"stateMutability":"nonpayable","type":"function"},{"stateMutability":"payable","type":"receive"}]
Contract Creation Code
6101206040523480156200001257600080fd5b50604051620026213803806200262183398101604081905262000035916200024c565b816001600160a01b031663026b1d5f6040518163ffffffff1660e01b8152600401602060405180830381865afa15801562000074573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200009a91906200028b565b6001600160a01b03166080816001600160a01b031681525050816001600160a01b031663707cd7166040518163ffffffff1660e01b8152600401602060405180830381865afa158015620000f2573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200011891906200028b565b6001600160a01b0390811660a052811660e08190526200013a5760006200019f565b806001600160a01b031663f97e48ee6040518163ffffffff1660e01b8152600401602060405180830381865afa15801562000179573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200019f91906200028b565b6001600160a01b0316610100816001600160a01b031681525050816001600160a01b031663cae5f11e6040518163ffffffff1660e01b8152600401602060405180830381865afa158015620001f8573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906200021e91906200028b565b6001600160a01b031660c05250620002b29050565b6001600160a01b03811681146200024957600080fd5b50565b600080604083850312156200026057600080fd5b82516200026d8162000233565b6020840151909250620002808162000233565b809150509250929050565b6000602082840312156200029e57600080fd5b8151620002ab8162000233565b9392505050565b60805160a05160c05160e051610100516122f26200032f60003960006108f901526000818161070a0152818161076f01526107c0015260008181610a030152610ad50152600081816103100152818161039e015281816104b4015281816105cb01528181610fa801526110360152600061130601526122f26000f3fe6080604052600436106100e15760003560e01c80634f9f6fe61161007f578063bb7bb27811610059578063bb7bb27814610255578063c00be5a11461028d578063dd7b0173146102ad578063df033494146102cd57600080fd5b80634f9f6fe6146101f35780636ba4c138146102205780638129fc1c1461024057600080fd5b806321b3da4c116100bb57806321b3da4c1461017e578063230f9ca21461019e578063233806b1146101b35780634d8d9ca5146101d357600080fd5b8063054f7d9c146100ed578063150b7a02146101235780631cea48411461016757600080fd5b366100e857005b600080fd5b3480156100f957600080fd5b5060345461010e90600160f81b900460ff1681565b60405190151581526020015b60405180910390f35b34801561012f57600080fd5b5061014e61013e366004611caf565b630a85bd0160e11b949350505050565b6040516001600160e01b0319909116815260200161011a565b34801561017357600080fd5b5061017c6102fb565b005b34801561018a57600080fd5b5061017c610199366004611d8f565b61049f565b3480156101aa57600080fd5b5061017c6105b6565b3480156101bf57600080fd5b5061017c6101ce366004611df4565b6106b7565b3480156101df57600080fd5b5061017c6101ee366004611df4565b61098b565b3480156101ff57600080fd5b5061021361020e366004611d8f565b610b4c565b60405161011a9190611ea5565b34801561022c57600080fd5b5061017c61023b366004611df4565b610cb9565b34801561024c57600080fd5b5061017c610e86565b34801561026157600080fd5b50603454610275906001600160f81b031681565b6040516001600160f81b03909116815260200161011a565b34801561029957600080fd5b5061017c6102a8366004611d8f565b610f93565b3480156102b957600080fd5b5061017c6102c8366004611df4565b61113d565b3480156102d957600080fd5b506102ed6102e8366004611f40565b6112e2565b60405190815260200161011a565b604051631280795b60e11b81523360048201527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690632500f2b690602401602060405180830381865afa15801561035f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906103839190611fed565b806104115750604051637be53ca160e01b81523360048201527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690637be53ca190602401602060405180830381865afa1580156103ed573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906104119190611fed565b604051806040016040528060018152602001603360f81b815250906104525760405162461bcd60e51b8152600401610449919061203a565b60405180910390fd5b50603480546001600160f81b0316600160f81b179055604051600181527f0ce8871c7e2eb42254688f1718b08852040553665ad8b4e64d57729e3bffcae8906020015b60405180910390a1565b604051637be53ca160e01b81523360048201527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690637be53ca190602401602060405180830381865afa158015610503573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105279190611fed565b604051806040016040528060018152602001603160f81b8152509061055f5760405162461bcd60e51b8152600401610449919061203a565b506000818152603360209081526040808320805462ff0000191690558051848152918201929092527f17d959c0b127f515500ffa7023094c3b316df7b6560c901b523cd2cdd182842791015b60405180910390a150565b604051637be53ca160e01b81523360048201527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690637be53ca190602401602060405180830381865afa15801561061a573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061063e9190611fed565b604051806040016040528060018152602001603160f81b815250906106765760405162461bcd60e51b8152600401610449919061203a565b50603480546001600160f81b03169055604051600081527f0ce8871c7e2eb42254688f1718b08852040553665ad8b4e64d57729e3bffcae890602001610495565b6002600154036106d95760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff16156107085760405162461bcd60e51b8152600401610449906120a4565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031661076d5760405162461bcd60e51b815260206004820152600c60248201526b7a65726f206164647265737360a01b6044820152606401610449565b7f000000000000000000000000000000000000000000000000000000000000000060005b828110156109815760006107bc8585848181106107b0576107b06120d0565b905060200201356116b3565b90507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031681606001516001600160a01b03161461083b5760405162461bcd60e51b815260206004820152601560248201527415dc9bdb99c81859dc99595b595b9d08185cdcd95d605a1b6044820152606401610449565b60c08101515160005b8181101561096b5760008360c001518281518110610864576108646120d0565b60200260200101519050856001600160a01b03166342966c68826040518263ffffffff1660e01b815260040161089c91815260200190565b600060405180830381600087803b1580156108b657600080fd5b505af11580156108ca573d6000803e3d6000fd5b5050505060808401516040516322dca8bb60e21b81526001600160a01b039182166004820152602481018390527f000000000000000000000000000000000000000000000000000000000000000090911690638b72a2ec90604401600060405180830381600087803b15801561093f57600080fd5b505af1158015610953573d6000803e3d6000fd5b50505050508080610963906120fc565b915050610844565b5050508080610979906120fc565b915050610791565b5050600180555050565b6002600154036109ad5760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff16156109dc5760405162461bcd60e51b8152600401610449906120a4565b6000805b82811015610abe5760006109ff8585848181106107b0576107b06120d0565b90507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031681606001516001600160a01b031614610a7e5760405162461bcd60e51b815260206004820152601560248201527415dc9bdb99c81859dc99595b595b9d08185cdcd95d605a1b6044820152606401610449565b8060c00151600081518110610a9557610a956120d0565b602002602001015183610aa89190612115565b9250508080610ab6906120fc565b9150506109e0565b50604051632e1a7d4d60e01b8152600481018290527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690632e1a7d4d90602401600060405180830381600087803b158015610b2157600080fd5b505af1158015610b35573d6000803e3d6000fd5b50505050610b4333826119bb565b50506001805550565b610b8f6040805160e08101909152806000815260200160008152600060208201819052604082018190526060808301829052608083019190915260a09091015290565b60008281526033602052604090819020815160e081019092528054829060ff166001811115610bc057610bc0611e36565b6001811115610bd157610bd1611e36565b81528154602090910190610100900460ff166001811115610bf457610bf4611e36565b6001811115610c0557610c05611e36565b8152815460ff6201000082041615156020808401919091526001600160a01b03630100000090920482166040808501919091526001850154928316606085015265ffffffffffff600160a01b90930492909216608084015260028401805483518184028101840190945280845260a0909401939091830182828015610ca957602002820191906000526020600020905b815481526020019060010190808311610c95575b5050505050815250509050919050565b600260015403610cdb5760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff1615610d0a5760405162461bcd60e51b8152600401610449906120a4565b60005b81811015610b43576000610d2c8484848181106107b0576107b06120d0565b9050600081516001811115610d4357610d43611e36565b03610d9157610d8c81608001518260c00151600081518110610d6757610d676120d0565b602002602001015183606001516001600160a01b0316611a739092919063ffffffff16565b610e73565b600181516001811115610da657610da6611e36565b03610e7357606081015160005b8260c0015151811015610e7057816001600160a01b03166342842e0e3085608001518660c001518581518110610deb57610deb6120d0565b60209081029190910101516040516001600160e01b031960e086901b1681526001600160a01b0393841660048201529290911660248301526044820152606401600060405180830381600087803b158015610e4557600080fd5b505af1158015610e59573d6000803e3d6000fd5b505050508080610e68906120fc565b915050610db3565b50505b5080610e7e816120fc565b915050610d0d565b600054610100900460ff1615808015610ea65750600054600160ff909116105b80610ec05750303b158015610ec0575060005460ff166001145b610f235760405162461bcd60e51b815260206004820152602e60248201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160448201526d191e481a5b9a5d1a585b1a5e995960921b6064820152608401610449565b6000805460ff191660011790558015610f46576000805461ff0019166101001790555b610f4e611b04565b8015610f90576000805461ff0019169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb3847402498906020016105ab565b50565b604051631280795b60e11b81523360048201527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690632500f2b690602401602060405180830381865afa158015610ff7573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061101b9190611fed565b806110a95750604051637be53ca160e01b81523360048201527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690637be53ca190602401602060405180830381865afa158015611085573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906110a99190611fed565b604051806040016040528060018152602001603360f81b815250906110e15760405162461bcd60e51b8152600401610449919061203a565b5060008181526033602052604090819020805462ff0000191662010000179055517f17d959c0b127f515500ffa7023094c3b316df7b6560c901b523cd2cdd1828427906105ab9083906001909182521515602082015260400190565b60026001540361115f5760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff161561118e5760405162461bcd60e51b8152600401610449906120a4565b60005b81811015610b435760006111b08484848181106107b0576107b06120d0565b90506001815160018111156111c7576111c7611e36565b146112075760405162461bcd60e51b815260206004820152601060248201526f57726f6e67206173736574207479706560801b6044820152606401610449565b606081015160005b8260c00151518110156112cc57816001600160a01b031663aa9678783085608001518660c001518581518110611247576112476120d0565b60209081029190910101516040516001600160e01b031960e086901b1681526001600160a01b0393841660048201529290911660248301526044820152606401600060405180830381600087803b1580156112a157600080fd5b505af11580156112b5573d6000803e3d6000fd5b5050505080806112c4906120fc565b91505061120f565b50505080806112da906120fc565b915050611191565b604051638d1a6a1f60e01b81526001600160a01b03808716600483015260009187917f00000000000000000000000000000000000000000000000000000000000000001690638d1a6a1f90602401602060405180830381865afa15801561134d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611371919061212e565b6001600160a01b0316336001600160a01b03161460405180604001604052806002815260200161313160f01b815250906113be5760405162461bcd60e51b8152600401610449919061203a565b506001600160a01b0384166114155760405162461bcd60e51b815260206004820181905260248201527f42656e65666963696172792063616e74206265207a65726f20616464726573736044820152606401610449565b428365ffffffffffff16116114655760405162461bcd60e51b815260206004820152601660248201527514995b19585cd9481d1a5b59481b9bdd081d985b1a5960521b6044820152606401610449565b603480546000916001600160f81b0390911690826114828361214b565b91906101000a8154816001600160f81b0302191690836001600160f81b031602179055506001600160f81b031690506040518060e001604052808b60018111156114ce576114ce611e36565b81526020018a60018111156114e5576114e5611e36565b8152602001600015158152602001896001600160a01b03168152602001866001600160a01b031681526020018565ffffffffffff16815260200188888080602002602001604051908101604052809392919081815260200183836020028082843760009201829052509390945250508381526033602052604090208251815491925090829060ff19166001838181111561158157611581611e36565b021790555060208201518154829061ff0019166101008360018111156115a9576115a9611e36565b021790555060408201518154606084015162010000600160b81b031990911662010000921515929092026301000000600160b81b0319169190911763010000006001600160a01b0392831602178255608083015160018301805460a0860151929093166001600160d01b031990931692909217600160a01b65ffffffffffff9092169190910217905560c0820151805161164d916002840191602090910190611c0a565b50905050846001600160a01b0316886001600160a01b03167f454cda23c2c757a228c6569d9f3db9c4cb8936936f8f73ae2fcf7ad1d40c2c1b838d8d8c8c8b60405161169e96959493929190612179565b60405180910390a39998505050505050505050565b6116f66040805160e08101909152806000815260200160008152600060208201819052604082018190526060808301829052608083019190915260a09091015290565b600082815260336020526040808220815160e081019092528054829060ff16600181111561172657611726611e36565b600181111561173757611737611e36565b81528154602090910190610100900460ff16600181111561175a5761175a611e36565b600181111561176b5761176b611e36565b8152815460ff6201000082041615156020808401919091526001600160a01b03630100000090920482166040808501919091526001850154928316606085015265ffffffffffff600160a01b90930492909216608084015260028401805483518184028101840190945280845260a090940193909183018282801561180f57602002820191906000526020600020905b8154815260200190600101908083116117fb575b505050505081525050905080608001516001600160a01b0316336001600160a01b0316146118715760405162461bcd60e51b815260206004820152600f60248201526e4e6f742062656e656669636961727960881b6044820152606401610449565b8060a0015165ffffffffffff164210156118cd5760405162461bcd60e51b815260206004820152601860248201527f52656c656173652074696d65206e6f74207265616368656400000000000000006044820152606401610449565b8060400151156119125760405162461bcd60e51b815260206004820152601060248201526f20b3b932b2b6b2b73a10333937bd32b760811b6044820152606401610449565b600083815260336020526040812080546001600160b81b03191681556001810180546001600160d01b03191690559061194e6002830182611c55565b505080608001516001600160a01b031681606001516001600160a01b03167fe5c357937d75c64e7b13a98e7becd6f3ebd4b9536e82ad116bec534b1dc29c1385846000015185602001518660c001516040516119ad94939291906121e8565b60405180910390a392915050565b604080516000808252602082019092526001600160a01b0384169083906040516119e59190612255565b60006040518083038185875af1925050503d8060008114611a22576040519150601f19603f3d011682016040523d82523d6000602084013e611a27565b606091505b5050905080611a6e5760405162461bcd60e51b815260206004820152601360248201527211551217d514905394d1915497d19052531151606a1b6044820152606401610449565b505050565b60405163a9059cbb60e01b8082526001600160a01b0384166004830152602482018390529060008060448382895af1611ab0573d6000803e3d6000fd5b50611aba84611b35565b611afe5760405162461bcd60e51b815260206004820152601560248201527423a83b191d103330b4b632b2103a3930b739b332b960591b6044820152606401610449565b50505050565b600054610100900460ff16611b2b5760405162461bcd60e51b815260040161044990612271565b611b33611bdd565b565b6000611b5a565b62461bcd60e51b600052602060045280602452508060445260646000fd5b3d8015611b995760208114611bca57611b947f475076323a206d616c666f726d6564207472616e7366657220726573756c7400601f611b3c565b611bd7565b823b611bc157611bc17311d41d8c8e881b9bdd08184818dbdb9d1c9858dd60621b6014611b3c565b60019150611bd7565b3d6000803e600051151591505b50919050565b600054610100900460ff16611c045760405162461bcd60e51b815260040161044990612271565b60018055565b828054828255906000526020600020908101928215611c45579160200282015b82811115611c45578251825591602001919060010190611c2a565b50611c51929150611c6f565b5090565b5080546000825590600052602060002090810190610f9091905b5b80821115611c515760008155600101611c70565b6001600160a01b0381168114610f9057600080fd5b634e487b7160e01b600052604160045260246000fd5b60008060008060808587031215611cc557600080fd5b8435611cd081611c84565b93506020850135611ce081611c84565b925060408501359150606085013567ffffffffffffffff80821115611d0457600080fd5b818701915087601f830112611d1857600080fd5b813581811115611d2a57611d2a611c99565b604051601f8201601f19908116603f01168101908382118183101715611d5257611d52611c99565b816040528281528a6020848701011115611d6b57600080fd5b82602086016020830137600060208483010152809550505050505092959194509250565b600060208284031215611da157600080fd5b5035919050565b60008083601f840112611dba57600080fd5b50813567ffffffffffffffff811115611dd257600080fd5b6020830191508360208260051b8501011115611ded57600080fd5b9250929050565b60008060208385031215611e0757600080fd5b823567ffffffffffffffff811115611e1e57600080fd5b611e2a85828601611da8565b90969095509350505050565b634e487b7160e01b600052602160045260246000fd5b60028110610f9057634e487b7160e01b600052602160045260246000fd5b600081518084526020808501945080840160005b83811015611e9a57815187529582019590820190600101611e7e565b509495945050505050565b6020815260008251611eb681611e4c565b806020840152506020830151611ecb81611e4c565b80604084015250604083015115156060830152606083015160018060a01b0380821660808501528060808601511660a0850152505065ffffffffffff60a08401511660c083015260c083015160e080840152611f2b610100840182611e6a565b949350505050565b60028110610f9057600080fd5b600080600080600080600060c0888a031215611f5b57600080fd5b8735611f6681611f33565b96506020880135611f7681611f33565b95506040880135611f8681611c84565b9450606088013567ffffffffffffffff811115611fa257600080fd5b611fae8a828b01611da8565b9095509350506080880135611fc281611c84565b915060a088013565ffffffffffff81168114611fdd57600080fd5b8091505092959891949750929550565b600060208284031215611fff57600080fd5b8151801515811461200f57600080fd5b9392505050565b60005b83811015612031578181015183820152602001612019565b50506000910152565b6020815260008251806020840152612059816040850160208701612016565b601f01601f19169190910160400192915050565b6020808252601f908201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c00604082015260600190565b6020808252601290820152712a34b6b2a637b1b59034b990333937bd32b760711b604082015260600190565b634e487b7160e01b600052603260045260246000fd5b634e487b7160e01b600052601160045260246000fd5b60006001820161210e5761210e6120e6565b5060010190565b80820180821115612128576121286120e6565b92915050565b60006020828403121561214057600080fd5b815161200f81611c84565b60006001600160f81b038281166002600160f81b0319810161216f5761216f6120e6565b6001019392505050565b86815261218586611e4c565b85602082015261219485611e4c565b6040810185905260a060608201819052810183905260006001600160fb1b038411156121bf57600080fd5b8360051b808660c085013765ffffffffffff939093166080830152500160c00195945050505050565b60006080820186835260206121fc87611e4c565b868185015261220a86611e4c565b60408401869052608060608501528451918290528085019160a085019060005b818110156122465784518352938301939183019160010161222a565b50909998505050505050505050565b60008251612267818460208701612016565b9190910192915050565b6020808252602b908201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960408201526a6e697469616c697a696e6760a81b60608201526080019056fea26469706673582212203afbffb7eefce3cd5b632d3ce48fe12a1b992d1bd7ad4900c9883c9573dca9d664736f6c63430008110033000000000000000000000000fae470a311f61944346bbb8709cdc2398506be46000000000000000000000000b7f7f6c52f2e2fdb1963eab30438024864c313f6
Deployed Bytecode
0x6080604052600436106100e15760003560e01c80634f9f6fe61161007f578063bb7bb27811610059578063bb7bb27814610255578063c00be5a11461028d578063dd7b0173146102ad578063df033494146102cd57600080fd5b80634f9f6fe6146101f35780636ba4c138146102205780638129fc1c1461024057600080fd5b806321b3da4c116100bb57806321b3da4c1461017e578063230f9ca21461019e578063233806b1146101b35780634d8d9ca5146101d357600080fd5b8063054f7d9c146100ed578063150b7a02146101235780631cea48411461016757600080fd5b366100e857005b600080fd5b3480156100f957600080fd5b5060345461010e90600160f81b900460ff1681565b60405190151581526020015b60405180910390f35b34801561012f57600080fd5b5061014e61013e366004611caf565b630a85bd0160e11b949350505050565b6040516001600160e01b0319909116815260200161011a565b34801561017357600080fd5b5061017c6102fb565b005b34801561018a57600080fd5b5061017c610199366004611d8f565b61049f565b3480156101aa57600080fd5b5061017c6105b6565b3480156101bf57600080fd5b5061017c6101ce366004611df4565b6106b7565b3480156101df57600080fd5b5061017c6101ee366004611df4565b61098b565b3480156101ff57600080fd5b5061021361020e366004611d8f565b610b4c565b60405161011a9190611ea5565b34801561022c57600080fd5b5061017c61023b366004611df4565b610cb9565b34801561024c57600080fd5b5061017c610e86565b34801561026157600080fd5b50603454610275906001600160f81b031681565b6040516001600160f81b03909116815260200161011a565b34801561029957600080fd5b5061017c6102a8366004611d8f565b610f93565b3480156102b957600080fd5b5061017c6102c8366004611df4565b61113d565b3480156102d957600080fd5b506102ed6102e8366004611f40565b6112e2565b60405190815260200161011a565b604051631280795b60e11b81523360048201527f0000000000000000000000000ba48b745c28d92db39eff320801df90923f219c6001600160a01b031690632500f2b690602401602060405180830381865afa15801561035f573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906103839190611fed565b806104115750604051637be53ca160e01b81523360048201527f0000000000000000000000000ba48b745c28d92db39eff320801df90923f219c6001600160a01b031690637be53ca190602401602060405180830381865afa1580156103ed573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906104119190611fed565b604051806040016040528060018152602001603360f81b815250906104525760405162461bcd60e51b8152600401610449919061203a565b60405180910390fd5b50603480546001600160f81b0316600160f81b179055604051600181527f0ce8871c7e2eb42254688f1718b08852040553665ad8b4e64d57729e3bffcae8906020015b60405180910390a1565b604051637be53ca160e01b81523360048201527f0000000000000000000000000ba48b745c28d92db39eff320801df90923f219c6001600160a01b031690637be53ca190602401602060405180830381865afa158015610503573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906105279190611fed565b604051806040016040528060018152602001603160f81b8152509061055f5760405162461bcd60e51b8152600401610449919061203a565b506000818152603360209081526040808320805462ff0000191690558051848152918201929092527f17d959c0b127f515500ffa7023094c3b316df7b6560c901b523cd2cdd182842791015b60405180910390a150565b604051637be53ca160e01b81523360048201527f0000000000000000000000000ba48b745c28d92db39eff320801df90923f219c6001600160a01b031690637be53ca190602401602060405180830381865afa15801561061a573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061063e9190611fed565b604051806040016040528060018152602001603160f81b815250906106765760405162461bcd60e51b8152600401610449919061203a565b50603480546001600160f81b03169055604051600081527f0ce8871c7e2eb42254688f1718b08852040553665ad8b4e64d57729e3bffcae890602001610495565b6002600154036106d95760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff16156107085760405162461bcd60e51b8152600401610449906120a4565b7f000000000000000000000000b7f7f6c52f2e2fdb1963eab30438024864c313f66001600160a01b031661076d5760405162461bcd60e51b815260206004820152600c60248201526b7a65726f206164647265737360a01b6044820152606401610449565b7f000000000000000000000000b7f7f6c52f2e2fdb1963eab30438024864c313f660005b828110156109815760006107bc8585848181106107b0576107b06120d0565b905060200201356116b3565b90507f000000000000000000000000b7f7f6c52f2e2fdb1963eab30438024864c313f66001600160a01b031681606001516001600160a01b03161461083b5760405162461bcd60e51b815260206004820152601560248201527415dc9bdb99c81859dc99595b595b9d08185cdcd95d605a1b6044820152606401610449565b60c08101515160005b8181101561096b5760008360c001518281518110610864576108646120d0565b60200260200101519050856001600160a01b03166342966c68826040518263ffffffff1660e01b815260040161089c91815260200190565b600060405180830381600087803b1580156108b657600080fd5b505af11580156108ca573d6000803e3d6000fd5b5050505060808401516040516322dca8bb60e21b81526001600160a01b039182166004820152602481018390527f000000000000000000000000b47e3cd837ddf8e4c57f05d70ab865de6e193bbb90911690638b72a2ec90604401600060405180830381600087803b15801561093f57600080fd5b505af1158015610953573d6000803e3d6000fd5b50505050508080610963906120fc565b915050610844565b5050508080610979906120fc565b915050610791565b5050600180555050565b6002600154036109ad5760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff16156109dc5760405162461bcd60e51b8152600401610449906120a4565b6000805b82811015610abe5760006109ff8585848181106107b0576107b06120d0565b90507f000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc26001600160a01b031681606001516001600160a01b031614610a7e5760405162461bcd60e51b815260206004820152601560248201527415dc9bdb99c81859dc99595b595b9d08185cdcd95d605a1b6044820152606401610449565b8060c00151600081518110610a9557610a956120d0565b602002602001015183610aa89190612115565b9250508080610ab6906120fc565b9150506109e0565b50604051632e1a7d4d60e01b8152600481018290527f000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc26001600160a01b031690632e1a7d4d90602401600060405180830381600087803b158015610b2157600080fd5b505af1158015610b35573d6000803e3d6000fd5b50505050610b4333826119bb565b50506001805550565b610b8f6040805160e08101909152806000815260200160008152600060208201819052604082018190526060808301829052608083019190915260a09091015290565b60008281526033602052604090819020815160e081019092528054829060ff166001811115610bc057610bc0611e36565b6001811115610bd157610bd1611e36565b81528154602090910190610100900460ff166001811115610bf457610bf4611e36565b6001811115610c0557610c05611e36565b8152815460ff6201000082041615156020808401919091526001600160a01b03630100000090920482166040808501919091526001850154928316606085015265ffffffffffff600160a01b90930492909216608084015260028401805483518184028101840190945280845260a0909401939091830182828015610ca957602002820191906000526020600020905b815481526020019060010190808311610c95575b5050505050815250509050919050565b600260015403610cdb5760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff1615610d0a5760405162461bcd60e51b8152600401610449906120a4565b60005b81811015610b43576000610d2c8484848181106107b0576107b06120d0565b9050600081516001811115610d4357610d43611e36565b03610d9157610d8c81608001518260c00151600081518110610d6757610d676120d0565b602002602001015183606001516001600160a01b0316611a739092919063ffffffff16565b610e73565b600181516001811115610da657610da6611e36565b03610e7357606081015160005b8260c0015151811015610e7057816001600160a01b03166342842e0e3085608001518660c001518581518110610deb57610deb6120d0565b60209081029190910101516040516001600160e01b031960e086901b1681526001600160a01b0393841660048201529290911660248301526044820152606401600060405180830381600087803b158015610e4557600080fd5b505af1158015610e59573d6000803e3d6000fd5b505050508080610e68906120fc565b915050610db3565b50505b5080610e7e816120fc565b915050610d0d565b600054610100900460ff1615808015610ea65750600054600160ff909116105b80610ec05750303b158015610ec0575060005460ff166001145b610f235760405162461bcd60e51b815260206004820152602e60248201527f496e697469616c697a61626c653a20636f6e747261637420697320616c72656160448201526d191e481a5b9a5d1a585b1a5e995960921b6064820152608401610449565b6000805460ff191660011790558015610f46576000805461ff0019166101001790555b610f4e611b04565b8015610f90576000805461ff0019169055604051600181527f7f26b83ff96e1f2b6a682f133852f6798a09c465da95921460cefb3847402498906020016105ab565b50565b604051631280795b60e11b81523360048201527f0000000000000000000000000ba48b745c28d92db39eff320801df90923f219c6001600160a01b031690632500f2b690602401602060405180830381865afa158015610ff7573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061101b9190611fed565b806110a95750604051637be53ca160e01b81523360048201527f0000000000000000000000000ba48b745c28d92db39eff320801df90923f219c6001600160a01b031690637be53ca190602401602060405180830381865afa158015611085573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906110a99190611fed565b604051806040016040528060018152602001603360f81b815250906110e15760405162461bcd60e51b8152600401610449919061203a565b5060008181526033602052604090819020805462ff0000191662010000179055517f17d959c0b127f515500ffa7023094c3b316df7b6560c901b523cd2cdd1828427906105ab9083906001909182521515602082015260400190565b60026001540361115f5760405162461bcd60e51b81526004016104499061206d565b6002600155603454600160f81b900460ff161561118e5760405162461bcd60e51b8152600401610449906120a4565b60005b81811015610b435760006111b08484848181106107b0576107b06120d0565b90506001815160018111156111c7576111c7611e36565b146112075760405162461bcd60e51b815260206004820152601060248201526f57726f6e67206173736574207479706560801b6044820152606401610449565b606081015160005b8260c00151518110156112cc57816001600160a01b031663aa9678783085608001518660c001518581518110611247576112476120d0565b60209081029190910101516040516001600160e01b031960e086901b1681526001600160a01b0393841660048201529290911660248301526044820152606401600060405180830381600087803b1580156112a157600080fd5b505af11580156112b5573d6000803e3d6000fd5b5050505080806112c4906120fc565b91505061120f565b50505080806112da906120fc565b915050611191565b604051638d1a6a1f60e01b81526001600160a01b03808716600483015260009187917f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff1690638d1a6a1f90602401602060405180830381865afa15801561134d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611371919061212e565b6001600160a01b0316336001600160a01b03161460405180604001604052806002815260200161313160f01b815250906113be5760405162461bcd60e51b8152600401610449919061203a565b506001600160a01b0384166114155760405162461bcd60e51b815260206004820181905260248201527f42656e65666963696172792063616e74206265207a65726f20616464726573736044820152606401610449565b428365ffffffffffff16116114655760405162461bcd60e51b815260206004820152601660248201527514995b19585cd9481d1a5b59481b9bdd081d985b1a5960521b6044820152606401610449565b603480546000916001600160f81b0390911690826114828361214b565b91906101000a8154816001600160f81b0302191690836001600160f81b031602179055506001600160f81b031690506040518060e001604052808b60018111156114ce576114ce611e36565b81526020018a60018111156114e5576114e5611e36565b8152602001600015158152602001896001600160a01b03168152602001866001600160a01b031681526020018565ffffffffffff16815260200188888080602002602001604051908101604052809392919081815260200183836020028082843760009201829052509390945250508381526033602052604090208251815491925090829060ff19166001838181111561158157611581611e36565b021790555060208201518154829061ff0019166101008360018111156115a9576115a9611e36565b021790555060408201518154606084015162010000600160b81b031990911662010000921515929092026301000000600160b81b0319169190911763010000006001600160a01b0392831602178255608083015160018301805460a0860151929093166001600160d01b031990931692909217600160a01b65ffffffffffff9092169190910217905560c0820151805161164d916002840191602090910190611c0a565b50905050846001600160a01b0316886001600160a01b03167f454cda23c2c757a228c6569d9f3db9c4cb8936936f8f73ae2fcf7ad1d40c2c1b838d8d8c8c8b60405161169e96959493929190612179565b60405180910390a39998505050505050505050565b6116f66040805160e08101909152806000815260200160008152600060208201819052604082018190526060808301829052608083019190915260a09091015290565b600082815260336020526040808220815160e081019092528054829060ff16600181111561172657611726611e36565b600181111561173757611737611e36565b81528154602090910190610100900460ff16600181111561175a5761175a611e36565b600181111561176b5761176b611e36565b8152815460ff6201000082041615156020808401919091526001600160a01b03630100000090920482166040808501919091526001850154928316606085015265ffffffffffff600160a01b90930492909216608084015260028401805483518184028101840190945280845260a090940193909183018282801561180f57602002820191906000526020600020905b8154815260200190600101908083116117fb575b505050505081525050905080608001516001600160a01b0316336001600160a01b0316146118715760405162461bcd60e51b815260206004820152600f60248201526e4e6f742062656e656669636961727960881b6044820152606401610449565b8060a0015165ffffffffffff164210156118cd5760405162461bcd60e51b815260206004820152601860248201527f52656c656173652074696d65206e6f74207265616368656400000000000000006044820152606401610449565b8060400151156119125760405162461bcd60e51b815260206004820152601060248201526f20b3b932b2b6b2b73a10333937bd32b760811b6044820152606401610449565b600083815260336020526040812080546001600160b81b03191681556001810180546001600160d01b03191690559061194e6002830182611c55565b505080608001516001600160a01b031681606001516001600160a01b03167fe5c357937d75c64e7b13a98e7becd6f3ebd4b9536e82ad116bec534b1dc29c1385846000015185602001518660c001516040516119ad94939291906121e8565b60405180910390a392915050565b604080516000808252602082019092526001600160a01b0384169083906040516119e59190612255565b60006040518083038185875af1925050503d8060008114611a22576040519150601f19603f3d011682016040523d82523d6000602084013e611a27565b606091505b5050905080611a6e5760405162461bcd60e51b815260206004820152601360248201527211551217d514905394d1915497d19052531151606a1b6044820152606401610449565b505050565b60405163a9059cbb60e01b8082526001600160a01b0384166004830152602482018390529060008060448382895af1611ab0573d6000803e3d6000fd5b50611aba84611b35565b611afe5760405162461bcd60e51b815260206004820152601560248201527423a83b191d103330b4b632b2103a3930b739b332b960591b6044820152606401610449565b50505050565b600054610100900460ff16611b2b5760405162461bcd60e51b815260040161044990612271565b611b33611bdd565b565b6000611b5a565b62461bcd60e51b600052602060045280602452508060445260646000fd5b3d8015611b995760208114611bca57611b947f475076323a206d616c666f726d6564207472616e7366657220726573756c7400601f611b3c565b611bd7565b823b611bc157611bc17311d41d8c8e881b9bdd08184818dbdb9d1c9858dd60621b6014611b3c565b60019150611bd7565b3d6000803e600051151591505b50919050565b600054610100900460ff16611c045760405162461bcd60e51b815260040161044990612271565b60018055565b828054828255906000526020600020908101928215611c45579160200282015b82811115611c45578251825591602001919060010190611c2a565b50611c51929150611c6f565b5090565b5080546000825590600052602060002090810190610f9091905b5b80821115611c515760008155600101611c70565b6001600160a01b0381168114610f9057600080fd5b634e487b7160e01b600052604160045260246000fd5b60008060008060808587031215611cc557600080fd5b8435611cd081611c84565b93506020850135611ce081611c84565b925060408501359150606085013567ffffffffffffffff80821115611d0457600080fd5b818701915087601f830112611d1857600080fd5b813581811115611d2a57611d2a611c99565b604051601f8201601f19908116603f01168101908382118183101715611d5257611d52611c99565b816040528281528a6020848701011115611d6b57600080fd5b82602086016020830137600060208483010152809550505050505092959194509250565b600060208284031215611da157600080fd5b5035919050565b60008083601f840112611dba57600080fd5b50813567ffffffffffffffff811115611dd257600080fd5b6020830191508360208260051b8501011115611ded57600080fd5b9250929050565b60008060208385031215611e0757600080fd5b823567ffffffffffffffff811115611e1e57600080fd5b611e2a85828601611da8565b90969095509350505050565b634e487b7160e01b600052602160045260246000fd5b60028110610f9057634e487b7160e01b600052602160045260246000fd5b600081518084526020808501945080840160005b83811015611e9a57815187529582019590820190600101611e7e565b509495945050505050565b6020815260008251611eb681611e4c565b806020840152506020830151611ecb81611e4c565b80604084015250604083015115156060830152606083015160018060a01b0380821660808501528060808601511660a0850152505065ffffffffffff60a08401511660c083015260c083015160e080840152611f2b610100840182611e6a565b949350505050565b60028110610f9057600080fd5b600080600080600080600060c0888a031215611f5b57600080fd5b8735611f6681611f33565b96506020880135611f7681611f33565b95506040880135611f8681611c84565b9450606088013567ffffffffffffffff811115611fa257600080fd5b611fae8a828b01611da8565b9095509350506080880135611fc281611c84565b915060a088013565ffffffffffff81168114611fdd57600080fd5b8091505092959891949750929550565b600060208284031215611fff57600080fd5b8151801515811461200f57600080fd5b9392505050565b60005b83811015612031578181015183820152602001612019565b50506000910152565b6020815260008251806020840152612059816040850160208701612016565b601f01601f19169190910160400192915050565b6020808252601f908201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c00604082015260600190565b6020808252601290820152712a34b6b2a637b1b59034b990333937bd32b760711b604082015260600190565b634e487b7160e01b600052603260045260246000fd5b634e487b7160e01b600052601160045260246000fd5b60006001820161210e5761210e6120e6565b5060010190565b80820180821115612128576121286120e6565b92915050565b60006020828403121561214057600080fd5b815161200f81611c84565b60006001600160f81b038281166002600160f81b0319810161216f5761216f6120e6565b6001019392505050565b86815261218586611e4c565b85602082015261219485611e4c565b6040810185905260a060608201819052810183905260006001600160fb1b038411156121bf57600080fd5b8360051b808660c085013765ffffffffffff939093166080830152500160c00195945050505050565b60006080820186835260206121fc87611e4c565b868185015261220a86611e4c565b60408401869052608060608501528451918290528085019160a085019060005b818110156122465784518352938301939183019160010161222a565b50909998505050505050505050565b60008251612267818460208701612016565b9190910192915050565b6020808252602b908201527f496e697469616c697a61626c653a20636f6e7472616374206973206e6f74206960408201526a6e697469616c697a696e6760a81b60608201526080019056fea26469706673582212203afbffb7eefce3cd5b632d3ce48fe12a1b992d1bd7ad4900c9883c9573dca9d664736f6c63430008110033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
000000000000000000000000fae470a311f61944346bbb8709cdc2398506be46000000000000000000000000b7f7f6c52f2e2fdb1963eab30438024864c313f6
-----Decoded View---------------
Arg [0] : provider (address): 0xfae470A311f61944346BbB8709CDc2398506Be46
Arg [1] : _wpunk (address): 0xb7F7F6C52F2e2fdb1963Eab30438024864c313F6
-----Encoded View---------------
2 Constructor Arguments found :
Arg [0] : 000000000000000000000000fae470a311f61944346bbb8709cdc2398506be46
Arg [1] : 000000000000000000000000b7f7f6c52f2e2fdb1963eab30438024864c313f6
Loading...
Loading
Loading...
Loading
Multichain Portfolio | 27 Chains
Chain | Token | Portfolio % | Price | Amount | Value |
---|
Loading...
Loading
[ Download: CSV Export ]
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.