Feature Tip: Add private address tag to any address under My Name Tag !
Source Code
Overview
ETH Balance
0 ETH
Eth Value
$0.00More Info
Private Name Tags
ContractCreator
TokenTracker
| Transaction Hash |
Method
|
Block
|
From
|
|
To
|
||||
|---|---|---|---|---|---|---|---|---|---|
Advanced mode: Intended for advanced users or developers and will display all Internal Transactions including zero value transfers.
Latest 25 internal transactions (View All)
Advanced mode:
| Parent Transaction Hash | Method | Block |
From
|
|
To
|
|||
|---|---|---|---|---|---|---|---|---|
| Get User Ape Sta... | 18525530 | 875 days ago | 0 ETH | |||||
| Avg Multiplier O... | 18525530 | 875 days ago | 0 ETH | |||||
| Collateralized B... | 18525530 | 875 days ago | 0 ETH | |||||
| Get X Token Type | 18525530 | 875 days ago | 0 ETH | |||||
| Get User Ape Sta... | 18525517 | 875 days ago | 0 ETH | |||||
| Get User Ape Sta... | 18524766 | 875 days ago | 0 ETH | |||||
| Avg Multiplier O... | 18524766 | 875 days ago | 0 ETH | |||||
| Collateralized B... | 18524766 | 875 days ago | 0 ETH | |||||
| Get X Token Type | 18524766 | 875 days ago | 0 ETH | |||||
| Get User Ape Sta... | 18524714 | 875 days ago | 0 ETH | |||||
| Avg Multiplier O... | 18524714 | 875 days ago | 0 ETH | |||||
| Collateralized B... | 18524714 | 875 days ago | 0 ETH | |||||
| Get X Token Type | 18524714 | 875 days ago | 0 ETH | |||||
| Get User Ape Sta... | 18524557 | 875 days ago | 0 ETH | |||||
| Avg Multiplier O... | 18524557 | 875 days ago | 0 ETH | |||||
| Collateralized B... | 18524557 | 875 days ago | 0 ETH | |||||
| Get X Token Type | 18524557 | 875 days ago | 0 ETH | |||||
| Get User Ape Sta... | 18524350 | 875 days ago | 0 ETH | |||||
| Get User Ape Sta... | 18524334 | 875 days ago | 0 ETH | |||||
| Get User Ape Sta... | 18524319 | 875 days ago | 0 ETH | |||||
| Deposit Ape Coin | 18524298 | 875 days ago | 0 ETH | |||||
| Owner Of | 18524298 | 875 days ago | 0 ETH | |||||
| Get BAKC | 18524298 | 875 days ago | 0 ETH | |||||
| Mint | 18524298 | 875 days ago | 0 ETH | |||||
| On ERC721Receive... | 18524298 | 875 days ago | 0 ETH |
Loading...
Loading
Loading...
Loading
Cross-Chain Transactions
Loading...
Loading
This contract may be a proxy contract. Click on More Options and select Is this a proxy? to confirm and enable the "Read as Proxy" & "Write as Proxy" tabs.
Contract Name:
NTokenBAYC
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: BUSL-1.1
pragma solidity ^0.8.0;
import {ApeCoinStaking} from "../../dependencies/yoga-labs/ApeCoinStaking.sol";
import {NTokenApeStaking} from "./NTokenApeStaking.sol";
import {IPool} from "../../interfaces/IPool.sol";
import {XTokenType} from "../../interfaces/IXTokenType.sol";
import {ApeStakingLogic} from "./libraries/ApeStakingLogic.sol";
/**
* @title BAYC NToken
*
* @notice Implementation of the NToken for the ParaSpace protocol
*/
contract NTokenBAYC is NTokenApeStaking {
constructor(
IPool pool,
address apeCoinStaking,
address delegateRegistry
) NTokenApeStaking(pool, apeCoinStaking, delegateRegistry) {}
/**
* @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 depositApeCoin(ApeCoinStaking.SingleNft[] calldata _nfts)
external
onlyPool
nonReentrant
{
_apeCoinStaking.depositBAYC(_nfts);
}
/**
* @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 claimApeCoin(uint256[] calldata _nfts, address _recipient)
external
onlyPool
nonReentrant
{
_apeCoinStaking.claimBAYC(_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
* @param _recipient Address to send withdraw amount and claim to
*/
function withdrawApeCoin(
ApeCoinStaking.SingleNft[] calldata _nfts,
address _recipient
) external onlyPool nonReentrant {
_apeCoinStaking.withdrawBAYC(_nfts, _recipient);
}
/**
* @notice Deposit ApeCoin to the Pair Pool, where Pair = (BAYC + BAKC)
* @param _nftPairs Array of PairNftWithAmount 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: BAYC + BAKC + 1 ApeCoin: [[0, 0, "1000000000000000000"]]\
*/
function depositBAKC(
ApeCoinStaking.PairNftDepositWithAmount[] calldata _nftPairs
) external onlyPool nonReentrant {
_apeCoinStaking.depositBAKC(
_nftPairs,
new ApeCoinStaking.PairNftDepositWithAmount[](0)
);
}
/**
* @notice Claim rewards for array of Paired NFTs and send to recipient
* @param _nftPairs Array of Paired BAYC/MAYC NFTs owned and committed by the msg.sender
* @param _recipient Address to send claim reward to
*/
function claimBAKC(
ApeCoinStaking.PairNft[] calldata _nftPairs,
address _recipient
) external onlyPool nonReentrant {
_apeCoinStaking.claimBAKC(
_nftPairs,
new ApeCoinStaking.PairNft[](0),
_recipient
);
}
/**
* @notice Withdraw staked ApeCoin from the Pair pool. If withdraw is total staked amount, performs an automatic claim.
* @param _nftPairs Array of Paired BAYC NFT's with staked amounts
* @dev if pairs have split ownership and BAKC is attempting a withdraw, the withdraw must be for the total staked amount
*/
function withdrawBAKC(
ApeCoinStaking.PairNftWithdrawWithAmount[] calldata _nftPairs,
address _apeRecipient
) external onlyPool nonReentrant {
ApeStakingLogic.withdrawBAKC(
_apeCoinStaking,
POOL_ID(),
_nftPairs,
_apeRecipient
);
}
function POOL_ID() internal pure virtual override returns (uint256) {
return ApeStakingLogic.BAYC_POOL_ID;
}
function getXTokenType() external pure override returns (XTokenType) {
return XTokenType.NTokenBAYC;
}
}// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.0;
/**
* @title An immutable registry contract to be deployed as a standalone primitive
* @dev See EIP-5639, new project launches can read previous cold wallet -> hot wallet delegations
* from here and integrate those permissions into their flow
*/
interface IDelegationRegistry {
/// @notice Delegation type
enum DelegationType {
NONE,
ALL,
CONTRACT,
TOKEN
}
/// @notice Info about a single delegation, used for onchain enumeration
struct DelegationInfo {
DelegationType type_;
address vault;
address delegate;
address contract_;
uint256 tokenId;
}
/// @notice Info about a single contract-level delegation
struct ContractDelegation {
address contract_;
address delegate;
}
/// @notice Info about a single token-level delegation
struct TokenDelegation {
address contract_;
uint256 tokenId;
address delegate;
}
/// @notice Emitted when a user delegates their entire wallet
event DelegateForAll(address vault, address delegate, bool value);
/// @notice Emitted when a user delegates a specific contract
event DelegateForContract(address vault, address delegate, address contract_, bool value);
/// @notice Emitted when a user delegates a specific token
event DelegateForToken(address vault, address delegate, address contract_, uint256 tokenId, bool value);
/// @notice Emitted when a user revokes all delegations
event RevokeAllDelegates(address vault);
/// @notice Emitted when a user revoes all delegations for a given delegate
event RevokeDelegate(address vault, address delegate);
/**
* ----------- WRITE -----------
*/
/**
* @notice Allow the delegate to act on your behalf for all contracts
* @param delegate The hotwallet to act on your behalf
* @param value Whether to enable or disable delegation for this address, true for setting and false for revoking
*/
function delegateForAll(address delegate, bool value) external;
/**
* @notice Allow the delegate to act on your behalf for a specific contract
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param value Whether to enable or disable delegation for this address, true for setting and false for revoking
*/
function delegateForContract(address delegate, address contract_, bool value) external;
/**
* @notice Allow the delegate to act on your behalf for a specific token
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param tokenId The token id for the token you're delegating
* @param value Whether to enable or disable delegation for this address, true for setting and false for revoking
*/
function delegateForToken(address delegate, address contract_, uint256 tokenId, bool value) external;
/**
* @notice Revoke all delegates
*/
function revokeAllDelegates() external;
/**
* @notice Revoke a specific delegate for all their permissions
* @param delegate The hotwallet to revoke
*/
function revokeDelegate(address delegate) external;
/**
* @notice Remove yourself as a delegate for a specific vault
* @param vault The vault which delegated to the msg.sender, and should be removed
*/
function revokeSelf(address vault) external;
/**
* ----------- READ -----------
*/
/**
* @notice Returns all active delegations a given delegate is able to claim on behalf of
* @param delegate The delegate that you would like to retrieve delegations for
* @return info Array of DelegationInfo structs
*/
function getDelegationsByDelegate(address delegate) external view returns (DelegationInfo[] memory);
/**
* @notice Returns an array of wallet-level delegates for a given vault
* @param vault The cold wallet who issued the delegation
* @return addresses Array of wallet-level delegates for a given vault
*/
function getDelegatesForAll(address vault) external view returns (address[] memory);
/**
* @notice Returns an array of contract-level delegates for a given vault and contract
* @param vault The cold wallet who issued the delegation
* @param contract_ The address for the contract you're delegating
* @return addresses Array of contract-level delegates for a given vault and contract
*/
function getDelegatesForContract(address vault, address contract_) external view returns (address[] memory);
/**
* @notice Returns an array of contract-level delegates for a given vault's token
* @param vault The cold wallet who issued the delegation
* @param contract_ The address for the contract holding the token
* @param tokenId The token id for the token you're delegating
* @return addresses Array of contract-level delegates for a given vault's token
*/
function getDelegatesForToken(address vault, address contract_, uint256 tokenId)
external
view
returns (address[] memory);
/**
* @notice Returns all contract-level delegations for a given vault
* @param vault The cold wallet who issued the delegations
* @return delegations Array of ContractDelegation structs
*/
function getContractLevelDelegations(address vault)
external
view
returns (ContractDelegation[] memory delegations);
/**
* @notice Returns all token-level delegations for a given vault
* @param vault The cold wallet who issued the delegations
* @return delegations Array of TokenDelegation structs
*/
function getTokenLevelDelegations(address vault) external view returns (TokenDelegation[] memory delegations);
/**
* @notice Returns true if the address is delegated to act on the entire vault
* @param delegate The hotwallet to act on your behalf
* @param vault The cold wallet who issued the delegation
*/
function checkDelegateForAll(address delegate, address vault) external view returns (bool);
/**
* @notice Returns true if the address is delegated to act on your behalf for a token contract or an entire vault
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param vault The cold wallet who issued the delegation
*/
function checkDelegateForContract(address delegate, address vault, address contract_)
external
view
returns (bool);
/**
* @notice Returns true if the address is delegated to act on your behalf for a specific token, the token's contract or an entire vault
* @param delegate The hotwallet to act on your behalf
* @param contract_ The address for the contract you're delegating
* @param tokenId The token id for the token you're delegating
* @param vault The cold wallet who issued the delegation
*/
function checkDelegateForToken(address delegate, address vault, address contract_, uint256 tokenId)
external
view
returns (bool);
}// 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
// 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
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC1155/IERC1155Receiver.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev _Available since v3.1._
*/
interface IERC1155Receiver is IERC165 {
/**
* @dev Handles the receipt of a single ERC1155 token type. This function is
* called at the end of a `safeTransferFrom` after the balance has been updated.
*
* NOTE: To accept the transfer, this must return
* `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))`
* (i.e. 0xf23a6e61, or its own function selector).
*
* @param operator The address which initiated the transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param id The ID of the token being transferred
* @param value The amount of tokens being transferred
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)"))` if transfer is allowed
*/
function onERC1155Received(
address operator,
address from,
uint256 id,
uint256 value,
bytes calldata data
) external returns (bytes4);
/**
* @dev Handles the receipt of a multiple ERC1155 token types. This function
* is called at the end of a `safeBatchTransferFrom` after the balances have
* been updated.
*
* NOTE: To accept the transfer(s), this must return
* `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))`
* (i.e. 0xbc197c81, or its own function selector).
*
* @param operator The address which initiated the batch transfer (i.e. msg.sender)
* @param from The address which previously owned the token
* @param ids An array containing ids of each token being transferred (order and length must match values array)
* @param values An array containing amounts of each token being transferred (order and length must match ids array)
* @param data Additional data with no specified format
* @return `bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)"))` if transfer is allowed
*/
function onERC1155BatchReceived(
address operator,
address from,
uint256[] calldata ids,
uint256[] calldata values,
bytes calldata data
) external returns (bytes4);
}// 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 (last updated v4.8.0) (security/ReentrancyGuard.sol)
pragma solidity ^0.8.0;
/**
* @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 ReentrancyGuard {
// 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;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
// On the first call to nonReentrant, _status will be _NOT_ENTERED
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function _nonReentrantAfter() private {
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
return _status == _ENTERED;
}
}// 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
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;
import {DataTypes} from "../protocol/libraries/types/DataTypes.sol";
/**
* @title IAuctionableERC721
* @author Parallel
* @notice Defines the basic interface for an AuctionableERC721.
**/
interface IAuctionableERC721 {
/**
* @dev get the auction configuration of a specific token
*/
function isAuctioned(uint256 tokenId) external view returns (bool);
/**
*
* @dev start auction
*/
function startAuction(uint256 tokenId) external;
/**
*
* @dev end auction
*/
function endAuction(uint256 tokenId) external;
/**
*
* @dev get auction data
*/
function getAuctionData(uint256 tokenId)
external
view
returns (DataTypes.Auction memory);
}// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.0;
/**
* @title ICollateralizableERC721
* @author Parallel
* @notice Defines the basic interface for an CollateralizableERC721.
**/
interface ICollateralizableERC721 {
/**
* @dev get the collateralized balance of a specific user
*/
function collateralizedBalanceOf(address user)
external
view
returns (uint256);
/**
* @dev get the the collateral configuration of a specific token
*/
function isUsedAsCollateral(uint256 tokenId) external view returns (bool);
/**
* @dev changes the collateral state/config of a token
* @return if the state has changed
*/
function setIsUsedAsCollateral(
uint256 tokenId,
bool useAsCollateral,
address sender
) external returns (bool);
/**
* @dev the ids of the token want to change the collateral state
* @return uint256 (user's old collateralized balance), uint256 (user's new collateralized balance)
*/
function batchSetIsUsedAsCollateral(
uint256[] calldata tokenIds,
bool useAsCollateral,
address sender
) external returns (uint256, uint256);
}// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.0;
import {IRewardController} from "./IRewardController.sol";
import {IPool} from "./IPool.sol";
/**
* @title IInitializablenToken
*
* @notice Interface for the initialize function on NToken
**/
interface IInitializableNToken {
/**
* @dev Emitted when an nToken is initialized
* @param underlyingAsset The address of the underlying asset
* @param pool The address of the associated pool
* @param incentivesController The address of the incentives controller for this nToken
* @param nTokenName The name of the nToken
* @param nTokenSymbol The symbol of the nToken
* @param params A set of encoded parameters for additional initialization
**/
event Initialized(
address indexed underlyingAsset,
address indexed pool,
address incentivesController,
string nTokenName,
string nTokenSymbol,
bytes params
);
/**
* @notice Initializes the nToken
* @param pool The pool contract that is initializing this contract
* @param underlyingAsset The address of the underlying asset of this nToken (E.g. WETH for pWETH)
* @param incentivesController The smart contract managing potential incentives distribution
* @param nTokenName The name of the nToken
* @param nTokenSymbol The symbol of the nToken
* @param params A set of encoded parameters for additional initialization
*/
function initialize(
IPool pool,
address underlyingAsset,
IRewardController incentivesController,
string calldata nTokenName,
string calldata nTokenSymbol,
bytes calldata params
) external;
}// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.0;
import {IERC721} from "../dependencies/openzeppelin/contracts/IERC721.sol";
import {IERC721Receiver} from "../dependencies/openzeppelin/contracts/IERC721Receiver.sol";
import {IERC721Enumerable} from "../dependencies/openzeppelin/contracts/IERC721Enumerable.sol";
import {IERC1155Receiver} from "../dependencies/openzeppelin/contracts/IERC1155Receiver.sol";
import {IInitializableNToken} from "./IInitializableNToken.sol";
import {IXTokenType} from "./IXTokenType.sol";
import {DataTypes} from "../protocol/libraries/types/DataTypes.sol";
/**
* @title INToken
* @author ParallelFi
* @notice Defines the basic interface for an NToken.
**/
interface INToken is
IERC721Enumerable,
IInitializableNToken,
IERC721Receiver,
IERC1155Receiver,
IXTokenType
{
/**
* @dev Emitted during rescueERC20()
* @param token The address of the token
* @param to The address of the recipient
* @param amount The amount being rescued
**/
event RescueERC20(
address indexed token,
address indexed to,
uint256 amount
);
/**
* @dev Emitted during rescueERC721()
* @param token The address of the token
* @param to The address of the recipient
* @param ids The ids of the tokens being rescued
**/
event RescueERC721(
address indexed token,
address indexed to,
uint256[] ids
);
/**
* @dev Emitted during RescueERC1155()
* @param token The address of the token
* @param to The address of the recipient
* @param ids The ids of the tokens being rescued
* @param amounts The amount of NFTs being rescued for a specific id.
* @param data The data of the tokens that is being rescued. Usually this is 0.
**/
event RescueERC1155(
address indexed token,
address indexed to,
uint256[] ids,
uint256[] amounts,
bytes data
);
/**
* @dev Emitted during executeAirdrop()
* @param airdropContract The address of the airdrop contract
**/
event ExecuteAirdrop(address indexed airdropContract);
/**
* @dev Emitted when trait multiplier got updated
*/
event TraitMultiplierSet(
address indexed owner,
uint256 indexed tokenId,
uint256 multiplier
);
/**
* @dev Emitted when user's avg multiplier got updated
*/
event AvgMultiplierUpdated(address indexed owner, uint256 avgMultiplier);
/**
* @notice Mints `amount` nTokens to `user`
* @param onBehalfOf The address of the user that will receive the minted nTokens
* @param tokenData The list of the tokens getting minted and their collateral configs
* @return old and new collateralized balance
*/
function mint(
address onBehalfOf,
DataTypes.ERC721SupplyParams[] calldata tokenData
) external returns (uint64, uint64);
/**
* @notice Burns nTokens from `user` and sends the equivalent amount of underlying to `receiverOfUnderlying`
* @dev In some instances, the mint event could be emitted from a burn transaction
* if the amount to burn is less than the interest that the user accrued
* @param from The address from which the nTokens will be burned
* @param receiverOfUnderlying The address that will receive the underlying
* @param tokenIds The ids of the tokens getting burned
* @return old and new collateralized balance
**/
function burn(
address from,
address receiverOfUnderlying,
uint256[] calldata tokenIds,
DataTypes.TimeLockParams calldata timeLockParams
) external returns (uint64, uint64);
// TODO are we using the Treasury at all? Can we remove?
// /**
// * @notice Mints nTokens to the reserve treasury
// * @param tokenId The id of the token getting minted
// * @param index The next liquidity index of the reserve
// */
// function mintToTreasury(uint256 tokenId, uint256 index) external;
/**
* @notice Transfers nTokens in the event of a borrow being liquidated, in case the liquidators reclaims the nToken
* @param from The address getting liquidated, current owner of the nTokens
* @param to The recipient
* @param tokenId The id of the token getting transferred
**/
function transferOnLiquidation(
address from,
address to,
uint256 tokenId
) external;
/**
* @notice Transfers the underlying asset to `target`.
* @dev Used by the Pool to transfer assets in borrow(), withdraw() and flashLoan()
* @param user The recipient of the underlying
* @param tokenId The id of the token getting transferred
**/
function transferUnderlyingTo(
address user,
uint256 tokenId,
DataTypes.TimeLockParams calldata timeLockParams
) external;
/**
* @notice Returns the address of the underlying asset of this nToken (E.g. WETH for pWETH)
* @return The address of the underlying asset
**/
function UNDERLYING_ASSET_ADDRESS() external view returns (address);
function claimUnderlying(
address timeLockV1,
uint256[] calldata agreementIds
) external;
}// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.0;
import "../dependencies/yoga-labs/ApeCoinStaking.sol";
import "./INToken.sol";
interface INTokenApeStaking {
function getBAKC() external view returns (IERC721);
function getApeStaking() external view returns (ApeCoinStaking);
function depositApeCoin(ApeCoinStaking.SingleNft[] calldata _nfts) external;
function claimApeCoin(uint256[] calldata _nfts, address _recipient)
external;
function withdrawApeCoin(
ApeCoinStaking.SingleNft[] calldata _nfts,
address _recipient
) external;
function depositBAKC(
ApeCoinStaking.PairNftDepositWithAmount[] calldata _nftPairs
) external;
function claimBAKC(
ApeCoinStaking.PairNft[] calldata _nftPairs,
address _recipient
) external;
function withdrawBAKC(
ApeCoinStaking.PairNftWithdrawWithAmount[] memory _nftPairs,
address _apeRecipient
) external;
function unstakePositionAndRepay(uint256 tokenId, address unstaker)
external;
function getUserApeStakingAmount(address user)
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: AGPL-3.0
pragma solidity ^0.8.0;
/**
* @title IRewardController
*
* @notice Defines the basic interface for an ParaSpace Incentives Controller.
**/
interface IRewardController {
/**
* @dev Emitted during `handleAction`, `claimRewards` and `claimRewardsOnBehalf`
* @param user The user that accrued rewards
* @param amount The amount of accrued rewards
*/
event RewardsAccrued(address indexed user, uint256 amount);
event RewardsClaimed(
address indexed user,
address indexed to,
uint256 amount
);
/**
* @dev Emitted during `claimRewards` and `claimRewardsOnBehalf`
* @param user The address that accrued rewards
* @param to The address that will be receiving the rewards
* @param claimer The address that performed the claim
* @param amount The amount of rewards
*/
event RewardsClaimed(
address indexed user,
address indexed to,
address indexed claimer,
uint256 amount
);
/**
* @dev Emitted during `setClaimer`
* @param user The address of the user
* @param claimer The address of the claimer
*/
event ClaimerSet(address indexed user, address indexed claimer);
/**
* @notice Returns the configuration of the distribution for a certain asset
* @param asset The address of the reference asset of the distribution
* @return The asset index
* @return The emission per second
* @return The last updated timestamp
**/
function getAssetData(address asset)
external
view
returns (
uint256,
uint256,
uint256
);
/**
* LEGACY **************************
* @dev Returns the configuration of the distribution for a certain asset
* @param asset The address of the reference asset of the distribution
* @return The asset index, the emission per second and the last updated timestamp
**/
function assets(address asset)
external
view
returns (
uint128,
uint128,
uint256
);
/**
* @notice Whitelists an address to claim the rewards on behalf of another address
* @param user The address of the user
* @param claimer The address of the claimer
*/
function setClaimer(address user, address claimer) external;
/**
* @notice Returns the whitelisted claimer for a certain address (0x0 if not set)
* @param user The address of the user
* @return The claimer address
*/
function getClaimer(address user) external view returns (address);
/**
* @notice Configure assets for a certain rewards emission
* @param assets The assets to incentivize
* @param emissionsPerSecond The emission for each asset
*/
function configureAssets(
address[] calldata assets,
uint256[] calldata emissionsPerSecond
) external;
/**
* @notice Called by the corresponding asset on any update that affects the rewards distribution
* @param asset The address of the user
* @param userBalance The balance of the user of the asset in the pool
* @param totalSupply The total supply of the asset in the pool
**/
function handleAction(
address asset,
uint256 totalSupply,
uint256 userBalance
) external;
/**
* @notice Returns the total of rewards of a user, already accrued + not yet accrued
* @param assets The assets to accumulate rewards for
* @param user The address of the user
* @return The rewards
**/
function getRewardsBalance(address[] calldata assets, address user)
external
view
returns (uint256);
/**
* @notice Claims reward for a user, on the assets of the pool, accumulating the pending rewards
* @param assets The assets to accumulate rewards for
* @param amount Amount of rewards to claim
* @param to Address that will be receiving the rewards
* @return Rewards claimed
**/
function claimRewards(
address[] calldata assets,
uint256 amount,
address to
) external returns (uint256);
/**
* @notice Claims reward for a user on its behalf, on the assets of the pool, accumulating the pending rewards.
* @dev The caller must be whitelisted via "allowClaimOnBehalf" function by the RewardsAdmin role manager
* @param assets The assets to accumulate rewards for
* @param amount The amount of rewards to claim
* @param user The address to check and claim rewards
* @param to The address that will be receiving the rewards
* @return The amount of rewards claimed
**/
function claimRewardsOnBehalf(
address[] calldata assets,
uint256 amount,
address user,
address to
) external returns (uint256);
/**
* @notice Returns the unclaimed rewards of the user
* @param user The address of the user
* @return The unclaimed user rewards
*/
function getUserUnclaimedRewards(address user)
external
view
returns (uint256);
/**
* @notice Returns the user index for a specific asset
* @param user The address of the user
* @param asset The asset to incentivize
* @return The user index for the asset
*/
function getUserAssetData(address user, address asset)
external
view
returns (uint256);
/**
* @notice for backward compatibility with previous implementation of the Incentives controller
* @return The address of the reward token
*/
function REWARD_TOKEN() external view returns (address);
/**
* @notice for backward compatibility with previous implementation of the Incentives controller
* @return The precision used in the incentives controller
*/
function PRECISION() external view returns (uint8);
/**
* @dev Gets the distribution end timestamp of the emissions
*/
function DISTRIBUTION_END() external view returns (uint256);
}// 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;
interface ITokenDelegation {
/**
* @notice Allow the delegate to act on your behalf for a specific token
* @param delegate The hotwallet to act on your behalf
* @param tokenIds The array of token ids for the tokens you're delegating
* @param value Whether to enable or disable delegation for this address, true for setting and false for revoking
*/
function delegateForToken(
address delegate,
uint256[] calldata tokenIds,
bool value
) external;
/**
* @notice Returns the address of the delegation registry of this nToken
* @return The address of the delegation registry
**/
function DELEGATE_REGISTRY() external view returns (address);
}// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.0;
/**
* @title IXTokenType
* @author ParallelFi
* @notice Defines the basic interface for an IXTokenType.
**/
enum XTokenType {
PhantomData, // unused
NToken,
NTokenMoonBirds,
NTokenUniswapV3,
NTokenBAYC,
NTokenMAYC,
PToken,
DelegationAwarePToken,
RebasingPToken,
PTokenAToken,
PTokenStETH,
PTokenSApe,
NTokenBAKC,
PYieldToken,
PTokenCAPE,
NTokenOtherdeed,
NTokenStakefish,
NTokenChromieSquiggle,
PhantomData1,
PhantomData2,
PhantomData3,
PhantomData4,
PhantomData5,
PhantomData6,
PhantomData7,
PhantomData8,
PhantomData9,
PhantomData10,
PTokenStKSM
}
interface IXTokenType {
/**
* @notice return token type`of xToken
**/
function getXTokenType() external pure returns (XTokenType);
}// 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 PercentageMath library
*
* @notice Provides functions to perform percentage calculations
* @dev Percentages are defined by default with 2 decimals of precision (100.00). The precision is indicated by PERCENTAGE_FACTOR
* @dev Operations are rounded. If a value is >=.5, will be rounded up, otherwise rounded down.
**/
library PercentageMath {
// Maximum percentage factor (100.00%)
uint256 internal constant PERCENTAGE_FACTOR = 1e4;
// Half percentage factor (50.00%)
uint256 internal constant HALF_PERCENTAGE_FACTOR = 0.5e4;
/**
* @notice Executes a percentage multiplication
* @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328
* @param value The value of which the percentage needs to be calculated
* @param percentage The percentage of the value to be calculated
* @return result value percentmul percentage
**/
function percentMul(uint256 value, uint256 percentage)
internal
pure
returns (uint256 result)
{
// to avoid overflow, value <= (type(uint256).max - HALF_PERCENTAGE_FACTOR) / percentage
assembly {
if iszero(
or(
iszero(percentage),
iszero(
gt(
value,
div(sub(not(0), HALF_PERCENTAGE_FACTOR), percentage)
)
)
)
) {
revert(0, 0)
}
result := div(
add(mul(value, percentage), HALF_PERCENTAGE_FACTOR),
PERCENTAGE_FACTOR
)
}
}
/**
* @notice Executes a percentage division
* @dev assembly optimized for improved gas savings, see https://twitter.com/transmissions11/status/1451131036377571328
* @param value The value of which the percentage needs to be calculated
* @param percentage The percentage of the value to be calculated
* @return result value percentdiv percentage
**/
function percentDiv(uint256 value, uint256 percentage)
internal
pure
returns (uint256 result)
{
// to avoid overflow, value <= (type(uint256).max - halfPercentage) / PERCENTAGE_FACTOR
assembly {
if or(
iszero(percentage),
iszero(
iszero(
gt(
value,
div(
sub(not(0), div(percentage, 2)),
PERCENTAGE_FACTOR
)
)
)
)
) {
revert(0, 0)
}
result := div(
add(mul(value, PERCENTAGE_FACTOR), div(percentage, 2)),
percentage
)
}
}
}// 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: AGPL-3.0
pragma solidity ^0.8.0;
/**
* @title VersionedInitializable
* , inspired by the OpenZeppelin Initializable contract
* @notice Helper contract to implement initializer functions. To use it, replace
* the constructor with a function that has the `initializer` modifier.
* @dev WARNING: Unlike constructors, initializer functions must be manually
* invoked. This applies both to deploying an Initializable contract, as well
* as extending an Initializable contract via inheritance.
* WARNING: When used with inheritance, manual care must be taken to not invoke
* a parent initializer twice, or ensure that all initializers are idempotent,
* because this is not dealt with automatically as with constructors.
*/
abstract contract VersionedInitializable {
/**
* @dev Indicates that the contract has been initialized.
*/
uint256 private lastInitializedRevision = 0;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private initializing;
/**
* @dev Modifier to use in the initializer function of a contract.
*/
modifier initializer() {
uint256 revision = getRevision();
require(
initializing ||
isConstructor() ||
revision > lastInitializedRevision,
"Contract instance has already been initialized"
);
bool isTopLevelCall = !initializing;
if (isTopLevelCall) {
initializing = true;
lastInitializedRevision = revision;
}
_;
if (isTopLevelCall) {
initializing = false;
}
}
/**
* @notice Returns the revision number of the contract
* @dev Needs to be defined in the inherited class as a constant.
* @return The revision number
**/
function getRevision() internal pure virtual returns (uint256);
/**
* @notice Returns true if and only if the function is running in the constructor
* @return True if the function is running in the constructor
**/
function isConstructor() private view returns (bool) {
// extcodesize checks the size of the code stored in an address, and
// address returns the current address. Since the code is still not
// deployed when running a constructor, any checks on its code size will
// yield zero, making it an effective way to detect if a contract is
// under construction or not.
uint256 cs;
//solium-disable-next-line
assembly {
cs := extcodesize(address())
}
return cs == 0;
}
// Reserved storage space to allow for layout changes in the future.
uint256[50] private ______gap;
}// 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;
}
}// SPDX-License-Identifier: BUSL-1.1
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 {IERC721Metadata} from "../../dependencies/openzeppelin/contracts/IERC721Metadata.sol";
import {Address} from "../../dependencies/openzeppelin/contracts/Address.sol";
import {GPv2SafeERC20} from "../../dependencies/gnosis/contracts/GPv2SafeERC20.sol";
import {SafeCast} from "../../dependencies/openzeppelin/contracts/SafeCast.sol";
import {VersionedInitializable} from "../libraries/paraspace-upgradeability/VersionedInitializable.sol";
import {Errors} from "../libraries/helpers/Errors.sol";
import {WadRayMath} from "../libraries/math/WadRayMath.sol";
import {IPool} from "../../interfaces/IPool.sol";
import {INToken} from "../../interfaces/INToken.sol";
import {IRewardController} from "../../interfaces/IRewardController.sol";
import {DataTypes} from "../libraries/types/DataTypes.sol";
import {SafeERC20} from "../../dependencies/openzeppelin/contracts/SafeERC20.sol";
import {MintableIncentivizedERC721} from "./base/MintableIncentivizedERC721.sol";
import {XTokenType} from "../../interfaces/IXTokenType.sol";
import {ITimeLock} from "../../interfaces/ITimeLock.sol";
import {ITokenDelegation} from "../../interfaces/ITokenDelegation.sol";
import {IDelegationRegistry} from "../../dependencies/delegation/IDelegationRegistry.sol";
/**
* @title ParaSpace ERC721 NToken
*
* @notice Implementation of the NFT derivative token for the ParaSpace protocol
*/
contract NToken is VersionedInitializable, MintableIncentivizedERC721, INToken {
using SafeERC20 for IERC20;
uint256 public constant NTOKEN_REVISION = 149;
/// @inheritdoc VersionedInitializable
function getRevision() internal pure virtual override returns (uint256) {
return NTOKEN_REVISION;
}
/**
* @dev Constructor.
* @param pool The address of the Pool contract
*/
constructor(
IPool pool,
bool atomic_pricing,
address delegateRegistry
)
MintableIncentivizedERC721(
pool,
"NTOKEN_IMPL",
"NTOKEN_IMPL",
atomic_pricing,
delegateRegistry
)
{}
function initialize(
IPool initializingPool,
address underlyingAsset,
IRewardController incentivesController,
string calldata nTokenName,
string calldata nTokenSymbol,
bytes calldata params
) public virtual override initializer {
require(initializingPool == POOL, Errors.POOL_ADDRESSES_DO_NOT_MATCH);
_setName(nTokenName);
_setSymbol(nTokenSymbol);
require(underlyingAsset != address(0), Errors.ZERO_ADDRESS_NOT_VALID);
_ERC721Data.underlyingAsset = underlyingAsset;
_ERC721Data.rewardController = incentivesController;
emit Initialized(
underlyingAsset,
address(POOL),
address(incentivesController),
nTokenName,
nTokenSymbol,
params
);
}
/// @inheritdoc INToken
function mint(
address onBehalfOf,
DataTypes.ERC721SupplyParams[] calldata tokenData
) external virtual override onlyPool nonReentrant returns (uint64, uint64) {
return _mintMultiple(onBehalfOf, tokenData);
}
/// @inheritdoc INToken
function burn(
address from,
address receiverOfUnderlying,
uint256[] calldata tokenIds,
DataTypes.TimeLockParams calldata timeLockParams
) external virtual override onlyPool nonReentrant returns (uint64, uint64) {
return _burn(from, receiverOfUnderlying, tokenIds, timeLockParams);
}
function _burn(
address from,
address receiverOfUnderlying,
uint256[] calldata tokenIds,
DataTypes.TimeLockParams calldata timeLockParams
)
internal
returns (
uint64 oldCollateralizedBalance,
uint64 newCollateralizedBalance
)
{
(oldCollateralizedBalance, newCollateralizedBalance) = _burnMultiple(
from,
tokenIds
);
if (receiverOfUnderlying != address(this)) {
address underlyingAsset = _ERC721Data.underlyingAsset;
if (timeLockParams.releaseTime != 0) {
ITimeLock timeLock = POOL.TIME_LOCK();
timeLock.createAgreement(
DataTypes.AssetType.ERC721,
timeLockParams.actionType,
underlyingAsset,
tokenIds,
receiverOfUnderlying,
timeLockParams.releaseTime
);
receiverOfUnderlying = address(timeLock);
}
for (uint256 index = 0; index < tokenIds.length; index++) {
IERC721(underlyingAsset).safeTransferFrom(
address(this),
receiverOfUnderlying,
tokenIds[index]
);
}
}
return (oldCollateralizedBalance, newCollateralizedBalance);
}
/// @inheritdoc INToken
function transferOnLiquidation(
address from,
address to,
uint256 value
) external onlyPool nonReentrant {
_transfer(from, to, value, false);
}
function setApprovalForAllTo(
address token,
address to,
bool _approved
) external onlyPoolAdmin {
IERC721(token).setApprovalForAll(to, _approved);
}
/// @inheritdoc INToken
function transferUnderlyingTo(
address target,
uint256 tokenId,
DataTypes.TimeLockParams calldata timeLockParams
) external virtual override onlyPool nonReentrant {
address underlyingAsset = _ERC721Data.underlyingAsset;
if (timeLockParams.releaseTime != 0) {
ITimeLock timeLock = POOL.TIME_LOCK();
uint256[] memory tokenIds = new uint256[](1);
tokenIds[0] = tokenId;
timeLock.createAgreement(
DataTypes.AssetType.ERC721,
timeLockParams.actionType,
underlyingAsset,
tokenIds,
target,
timeLockParams.releaseTime
);
target = address(timeLock);
}
IERC721(underlyingAsset).safeTransferFrom(
address(this),
target,
tokenId
);
}
/**
* @notice Transfers the nTokens between two users. Validates the transfer
* (ie checks for valid HF after the transfer) if required
* @param from The source address
* @param to The destination address
* @param tokenId The amount getting transferred
* @param validate True if the transfer needs to be validated, false otherwise
**/
function _transfer(
address from,
address to,
uint256 tokenId,
bool validate
) internal virtual {
address underlyingAsset = _ERC721Data.underlyingAsset;
uint256 fromBalanceBefore;
if (validate) {
fromBalanceBefore = collateralizedBalanceOf(from);
}
bool isUsedAsCollateral = _transferCollateralizable(from, to, tokenId);
if (validate) {
POOL.finalizeTransferERC721(
underlyingAsset,
tokenId,
from,
to,
isUsedAsCollateral,
fromBalanceBefore
);
}
}
/**
* @notice Overrides the parent _transfer to force validated transfer() and transferFrom()
* @param from The source address
* @param to The destination address
* @param tokenId The token id getting transferred
**/
function _transfer(
address from,
address to,
uint256 tokenId
) internal override {
_transfer(from, to, tokenId, true);
}
function onERC721Received(
address,
address,
uint256,
bytes memory
) external virtual override returns (bytes4) {
return this.onERC721Received.selector;
}
function onERC1155Received(
address,
address,
uint256,
uint256,
bytes calldata
) external pure override returns (bytes4) {
return this.onERC1155Received.selector;
}
function onERC1155BatchReceived(
address,
address,
uint256[] calldata,
uint256[] calldata,
bytes calldata
) external pure override returns (bytes4) {
return this.onERC1155BatchReceived.selector;
}
function UNDERLYING_ASSET_ADDRESS() external view returns (address) {
return _ERC721Data.underlyingAsset;
}
function getXTokenType()
external
pure
virtual
override
returns (XTokenType)
{
return XTokenType.NToken;
}
function claimUnderlying(
address timeLockV1,
uint256[] calldata agreementIds
) external virtual onlyPool {
ITimeLock(timeLockV1).claim(agreementIds);
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import {NToken} from "./NToken.sol";
import {ApeCoinStaking} from "../../dependencies/yoga-labs/ApeCoinStaking.sol";
import {IPool} from "../../interfaces/IPool.sol";
import {IERC20} from "../../dependencies/openzeppelin/contracts/IERC20.sol";
import {IERC721} from "../../dependencies/openzeppelin/contracts/IERC721.sol";
import {IRewardController} from "../../interfaces/IRewardController.sol";
import {ApeStakingLogic} from "./libraries/ApeStakingLogic.sol";
import "../../interfaces/INTokenApeStaking.sol";
import {DataTypes} from "../libraries/types/DataTypes.sol";
/**
* @title ApeCoinStaking NToken
*
* @notice Implementation of the NToken for the ParaSpace protocol
*/
abstract contract NTokenApeStaking is NToken, INTokenApeStaking {
ApeCoinStaking immutable _apeCoinStaking;
bytes32 constant APE_STAKING_DATA_STORAGE_POSITION =
bytes32(
uint256(keccak256("paraspace.proxy.ntoken.apestaking.storage")) - 1
);
/**
* @dev Default percentage of borrower's ape position to be repaid as incentive in a unstaking transaction.
* @dev Percentage applied when the users ape position got unstaked by others.
* Expressed in bps, a value of 30 results in 0.3%
*/
uint256 internal constant DEFAULT_UNSTAKE_INCENTIVE_PERCENTAGE = 30;
/**
* @dev Constructor.
* @param pool The address of the Pool contract
*/
constructor(
IPool pool,
address apeCoinStaking,
address delegateRegistry
) NToken(pool, false, delegateRegistry) {
_apeCoinStaking = ApeCoinStaking(apeCoinStaking);
}
function initialize(
IPool initializingPool,
address underlyingAsset,
IRewardController incentivesController,
string calldata nTokenName,
string calldata nTokenSymbol,
bytes calldata params
) public virtual override initializer {
IERC20 _apeCoin = _apeCoinStaking.apeCoin();
//approve for apeCoinStaking
uint256 allowance = IERC20(_apeCoin).allowance(
address(this),
address(_apeCoinStaking)
);
if (allowance == 0) {
IERC20(_apeCoin).approve(
address(_apeCoinStaking),
type(uint256).max
);
}
//approve for Pool contract
allowance = IERC20(_apeCoin).allowance(address(this), address(POOL));
if (allowance == 0) {
IERC20(_apeCoin).approve(address(POOL), type(uint256).max);
}
getBAKC().setApprovalForAll(address(POOL), true);
super.initialize(
initializingPool,
underlyingAsset,
incentivesController,
nTokenName,
nTokenSymbol,
params
);
initializeStakingData();
}
/**
* @notice Returns the address of BAKC contract address.
**/
function getBAKC() public view returns (IERC721) {
return _apeCoinStaking.nftContracts(ApeStakingLogic.BAKC_POOL_ID);
}
/**
* @notice Returns the address of ApeCoinStaking contract address.
**/
function getApeStaking() external view returns (ApeCoinStaking) {
return _apeCoinStaking;
}
/**
* @notice Overrides the _transfer from NToken to withdraw all staked and pending rewards before transfer the asset
*/
function _transfer(
address from,
address to,
uint256 tokenId,
bool validate
) internal override {
ApeStakingLogic.executeUnstakePositionAndRepay(
_ERC721Data.owners,
apeStakingDataStorage(),
ApeStakingLogic.UnstakeAndRepayParams({
POOL: POOL,
_apeCoinStaking: _apeCoinStaking,
_underlyingAsset: _ERC721Data.underlyingAsset,
poolId: POOL_ID(),
tokenId: tokenId,
incentiveReceiver: address(0),
bakcNToken: getBAKCNTokenAddress()
})
);
super._transfer(from, to, tokenId, validate);
}
/**
* @notice Overrides the burn from NToken to withdraw all staked and pending rewards before burning the NToken on liquidation/withdraw
*/
function burn(
address from,
address receiverOfUnderlying,
uint256[] calldata tokenIds,
DataTypes.TimeLockParams calldata timeLockParams
) external virtual override onlyPool nonReentrant returns (uint64, uint64) {
for (uint256 index = 0; index < tokenIds.length; index++) {
ApeStakingLogic.executeUnstakePositionAndRepay(
_ERC721Data.owners,
apeStakingDataStorage(),
ApeStakingLogic.UnstakeAndRepayParams({
POOL: POOL,
_apeCoinStaking: _apeCoinStaking,
_underlyingAsset: _ERC721Data.underlyingAsset,
poolId: POOL_ID(),
tokenId: tokenIds[index],
incentiveReceiver: address(0),
bakcNToken: getBAKCNTokenAddress()
})
);
}
return _burn(from, receiverOfUnderlying, tokenIds, timeLockParams);
}
function POOL_ID() internal pure virtual returns (uint256) {
// should be overridden
return 0;
}
function initializeStakingData() internal {
ApeStakingLogic.APEStakingParameter
storage dataStorage = apeStakingDataStorage();
ApeStakingLogic.executeSetUnstakeApeIncentive(
dataStorage,
DEFAULT_UNSTAKE_INCENTIVE_PERCENTAGE
);
}
function setUnstakeApeIncentive(uint256 incentive) external onlyPoolAdmin {
ApeStakingLogic.executeSetUnstakeApeIncentive(
apeStakingDataStorage(),
incentive
);
}
function apeStakingDataStorage()
internal
pure
returns (ApeStakingLogic.APEStakingParameter storage rgs)
{
bytes32 position = APE_STAKING_DATA_STORAGE_POSITION;
assembly {
rgs.slot := position
}
}
/**
* @notice Unstake Ape coin staking position and repay user debt
* @param tokenId Token id of the ape staking position on
* @param incentiveReceiver address to receive incentive
*/
function unstakePositionAndRepay(uint256 tokenId, address incentiveReceiver)
external
nonReentrant
{
address bakcNToken = getBAKCNTokenAddress();
require(
msg.sender == address(POOL) || msg.sender == bakcNToken,
"Invalid Caller"
);
ApeStakingLogic.executeUnstakePositionAndRepay(
_ERC721Data.owners,
apeStakingDataStorage(),
ApeStakingLogic.UnstakeAndRepayParams({
POOL: POOL,
_apeCoinStaking: _apeCoinStaking,
_underlyingAsset: _ERC721Data.underlyingAsset,
poolId: POOL_ID(),
tokenId: tokenId,
incentiveReceiver: incentiveReceiver,
bakcNToken: bakcNToken
})
);
}
/**
* @notice get user total ape staking position
* @param user user address
*/
function getUserApeStakingAmount(address user)
external
view
returns (uint256)
{
return
ApeStakingLogic.getUserTotalStakingAmount(
_ERC721Data.userState,
_ERC721Data.ownedTokens,
_ERC721Data.underlyingAsset,
user,
POOL_ID(),
_apeCoinStaking
);
}
function getBAKCNTokenAddress() internal view returns (address) {
return POOL.getReserveData(address(getBAKC())).xTokenAddress;
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import {Context} from "../../../dependencies/openzeppelin/contracts/Context.sol";
import {Strings} from "../../../dependencies/openzeppelin/contracts/Strings.sol";
import {Address} from "../../../dependencies/openzeppelin/contracts/Address.sol";
import {IERC165} from "../../../dependencies/openzeppelin/contracts/IERC165.sol";
import {IERC721Metadata} from "../../../dependencies/openzeppelin/contracts/IERC721Metadata.sol";
import {IERC20} from "../../../dependencies/openzeppelin/contracts/IERC20.sol";
import {IERC1155} from "../../../dependencies/openzeppelin/contracts/IERC1155.sol";
import {IERC721} from "../../../dependencies/openzeppelin/contracts/IERC721.sol";
import {IERC721Receiver} from "../../../dependencies/openzeppelin/contracts/IERC721Receiver.sol";
import {IERC721Enumerable} from "../../../dependencies/openzeppelin/contracts/IERC721Enumerable.sol";
import {ICollateralizableERC721} from "../../../interfaces/ICollateralizableERC721.sol";
import {IAtomicCollateralizableERC721} from "../../../interfaces/IAtomicCollateralizableERC721.sol";
import {IAuctionableERC721} from "../../../interfaces/IAuctionableERC721.sol";
import {ITokenDelegation} from "../../../interfaces/ITokenDelegation.sol";
import {IDelegationRegistry} from "../../../dependencies/delegation/IDelegationRegistry.sol";
import {SafeCast} from "../../../dependencies/openzeppelin/contracts/SafeCast.sol";
import {WadRayMath} from "../../libraries/math/WadRayMath.sol";
import {Errors} from "../../libraries/helpers/Errors.sol";
import {IRewardController} from "../../../interfaces/IRewardController.sol";
import {IPoolAddressesProvider} from "../../../interfaces/IPoolAddressesProvider.sol";
import {IPool} from "../../../interfaces/IPool.sol";
import {IACLManager} from "../../../interfaces/IACLManager.sol";
import {DataTypes} from "../../libraries/types/DataTypes.sol";
import {ReentrancyGuard} from "../../../dependencies/openzeppelin/contracts/ReentrancyGuard.sol";
import {MintableERC721Logic, UserState, MintableERC721Data} from "../libraries/MintableERC721Logic.sol";
import {Helpers} from "../../libraries/helpers/Helpers.sol";
import {SafeERC20} from "../../../dependencies/openzeppelin/contracts/SafeERC20.sol";
/**
* @title MintableIncentivizedERC721
* , inspired by the Openzeppelin ERC721 implementation
* @notice Basic ERC721 implementation
**/
abstract contract MintableIncentivizedERC721 is
ReentrancyGuard,
ICollateralizableERC721,
IAtomicCollateralizableERC721,
IAuctionableERC721,
ITokenDelegation,
Context,
IERC721Metadata,
IERC721Enumerable,
IERC165
{
using Address for address;
using SafeERC20 for IERC20;
MintableERC721Data internal _ERC721Data;
function _onlyPoolAdmin() private view {
IACLManager aclManager = IACLManager(
_addressesProvider.getACLManager()
);
require(
aclManager.isPoolAdmin(msg.sender),
Errors.CALLER_NOT_POOL_ADMIN
);
}
function _onlyPool() private view {
require(_msgSender() == address(POOL), Errors.CALLER_MUST_BE_POOL);
}
/**
* @dev Only pool admin can call functions marked by this modifier.
**/
modifier onlyPoolAdmin() {
_onlyPoolAdmin();
_;
}
/**
* @dev Only pool can call functions marked by this modifier.
**/
modifier onlyPool() {
_onlyPool();
_;
}
/**
* @dev UserState - additionalData is a flexible field.
* PTokens and VariableDebtTokens use this field store the index of the
* user's last supply/withdrawal/borrow/repayment. StableDebtTokens use
* this field to store the user's stable rate.
*/
IPoolAddressesProvider internal immutable _addressesProvider;
IPool internal immutable POOL;
bool internal immutable ATOMIC_PRICING;
address internal immutable DELEGATE_REGISTRY_ADDRESS;
/**
* @dev Constructor.
* @param pool The reference to the main Pool contract
* @param name_ The name of the token
* @param symbol_ The symbol of the token
*/
constructor(
IPool pool,
string memory name_,
string memory symbol_,
bool atomic_pricing,
address delegateRegistry
) {
_addressesProvider = pool.ADDRESSES_PROVIDER();
_ERC721Data.name = name_;
_ERC721Data.symbol = symbol_;
POOL = pool;
ATOMIC_PRICING = atomic_pricing;
DELEGATE_REGISTRY_ADDRESS = delegateRegistry;
}
function name() public view override returns (string memory) {
return _ERC721Data.name;
}
function symbol() external view override returns (string memory) {
return _ERC721Data.symbol;
}
function balanceOf(address account)
public
view
virtual
override
returns (uint256)
{
return _ERC721Data.userState[account].balance;
}
/**
* @notice Returns the address of the Incentives Controller contract
* @return The address of the Incentives Controller
**/
function getIncentivesController()
external
view
virtual
returns (IRewardController)
{
return _ERC721Data.rewardController;
}
/**
* @notice Sets a new Incentives Controller
* @param controller the new Incentives controller
**/
function setIncentivesController(IRewardController controller)
external
onlyPoolAdmin
{
_ERC721Data.rewardController = controller;
}
/**
* @notice Sets new Balance Limit
* @param limit the new Balance Limit
**/
function setBalanceLimit(uint64 limit) external onlyPoolAdmin {
_ERC721Data.balanceLimit = limit;
}
/**
* @notice Update the name of the token
* @param newName The new name for the token
*/
function _setName(string memory newName) internal {
_ERC721Data.name = newName;
}
/**
* @notice Update the symbol for the token
* @param newSymbol The new symbol for the token
*/
function _setSymbol(string memory newSymbol) internal {
_ERC721Data.symbol = newSymbol;
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId)
public
view
virtual
override
returns (address)
{
return _ERC721Data.owners[tokenId];
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId)
external
view
virtual
override
returns (string memory)
{
return IERC721Metadata(_ERC721Data.underlyingAsset).tokenURI(tokenId);
}
/**
* @dev See {IERC721-approve}.
*/
function approve(address to, uint256 tokenId) external virtual override {
address owner = ownerOf(tokenId);
require(to != owner, "ERC721: approval to old owner");
require(
_msgSender() == owner || isApprovedForAll(owner, _msgSender()),
"ERC721: approve caller is not owner nor approved for all"
);
MintableERC721Logic.executeApprove(_ERC721Data, 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 _ERC721Data.tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved)
external
virtual
override
{
MintableERC721Logic.executeApprovalForAll(
_ERC721Data,
_msgSender(),
operator,
approved
);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address owner, address operator)
public
view
virtual
override
returns (bool)
{
return _ERC721Data.operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) external virtual override nonReentrant {
//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
) external virtual override nonReentrant {
_safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes memory _data
) external virtual override nonReentrant {
_safeTransferFrom(from, to, tokenId, _data);
}
function _safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes memory _data
) internal {
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`.
*
* Emits a {Transfer} event.
*/
function _safeTransfer(
address from,
address to,
uint256 tokenId,
bytes memory
) internal virtual {
_transfer(from, to, tokenId);
}
/**
* @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 _ERC721Data.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 = ownerOf(tokenId);
return (spender == owner ||
isApprovedForAll(owner, spender) ||
getApproved(tokenId) == spender);
}
function _mintMultiple(
address to,
DataTypes.ERC721SupplyParams[] calldata tokenData
)
internal
virtual
returns (
uint64 oldCollateralizedBalance,
uint64 newCollateralizedBalance
)
{
return
MintableERC721Logic.executeMintMultiple(
_ERC721Data,
ATOMIC_PRICING,
to,
tokenData
);
}
function _burnMultiple(address user, uint256[] calldata tokenIds)
internal
virtual
returns (
uint64 oldCollateralizedBalance,
uint64 newCollateralizedBalance
)
{
return
MintableERC721Logic.executeBurnMultiple(
_ERC721Data,
POOL,
ATOMIC_PRICING,
DELEGATE_REGISTRY_ADDRESS,
user,
tokenIds
);
}
function delegateForToken(
address delegate,
uint256[] calldata tokenIds,
bool value
) external nonReentrant {
for (uint256 index = 0; index < tokenIds.length; index++) {
require(
msg.sender == ownerOf(tokenIds[index]),
Errors.NOT_THE_OWNER
);
require(
!value ||
_ERC721Data.tokenDelegations[tokenIds[index]] == address(0),
Errors.TOKEN_ALREADY_DELEGATED
);
MintableERC721Logic.executeUpdateTokenDelegation(
_ERC721Data,
DELEGATE_REGISTRY_ADDRESS,
delegate,
tokenIds[index],
value
);
}
}
function DELEGATE_REGISTRY() external view returns (address) {
return DELEGATE_REGISTRY_ADDRESS;
}
/**
* @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 {
MintableERC721Logic.executeTransfer(
_ERC721Data,
POOL,
ATOMIC_PRICING,
DELEGATE_REGISTRY_ADDRESS,
from,
to,
tokenId
);
}
/**
* @dev update collateral information on transfer
*/
function _transferCollateralizable(
address from,
address to,
uint256 tokenId
) internal virtual returns (bool) {
return
MintableERC721Logic.executeTransferCollateralizable(
_ERC721Data,
POOL,
ATOMIC_PRICING,
DELEGATE_REGISTRY_ADDRESS,
from,
to,
tokenId
);
}
/// @inheritdoc ICollateralizableERC721
function collateralizedBalanceOf(address account)
public
view
virtual
override
returns (uint256)
{
return _ERC721Data.userState[account].collateralizedBalance;
}
/// @inheritdoc ICollateralizableERC721
function setIsUsedAsCollateral(
uint256 tokenId,
bool useAsCollateral,
address sender
) external virtual override onlyPool nonReentrant returns (bool) {
return
MintableERC721Logic.executeSetIsUsedAsCollateral(
_ERC721Data,
POOL,
ATOMIC_PRICING,
tokenId,
useAsCollateral,
sender
);
}
/// @inheritdoc ICollateralizableERC721
function batchSetIsUsedAsCollateral(
uint256[] calldata tokenIds,
bool useAsCollateral,
address sender
)
external
virtual
override
onlyPool
nonReentrant
returns (uint256, uint256)
{
return
MintableERC721Logic.executeBatchSetIsUsedAsCollateral(
_ERC721Data,
POOL,
ATOMIC_PRICING,
tokenIds,
useAsCollateral,
sender
);
}
/// @inheritdoc ICollateralizableERC721
function isUsedAsCollateral(uint256 tokenId)
external
view
override
returns (bool)
{
return _ERC721Data.isUsedAsCollateral[tokenId];
}
/// @inheritdoc IAuctionableERC721
function isAuctioned(uint256 tokenId)
external
view
override
returns (bool)
{
return MintableERC721Logic.isAuctioned(_ERC721Data, POOL, tokenId);
}
/// @inheritdoc IAtomicCollateralizableERC721
function isAtomicPricing() external view virtual returns (bool) {
return ATOMIC_PRICING;
}
/// @inheritdoc IAtomicCollateralizableERC721
function avgMultiplierOf(address user) external view returns (uint256) {
return
MintableERC721Logic.getTraitMultiplier(
_ERC721Data.userState[user].avgMultiplier
);
}
/// @inheritdoc IAuctionableERC721
function startAuction(uint256 tokenId)
external
virtual
override
onlyPool
nonReentrant
{
MintableERC721Logic.executeStartAuction(_ERC721Data, POOL, tokenId);
}
/// @inheritdoc IAuctionableERC721
function endAuction(uint256 tokenId)
external
virtual
override
onlyPool
nonReentrant
{
MintableERC721Logic.executeEndAuction(_ERC721Data, POOL, tokenId);
}
function setTraitsMultipliers(
uint256[] calldata tokenIds,
uint256[] calldata multipliers
) external virtual onlyPoolAdmin nonReentrant {
MintableERC721Logic.executeSetTraitsMultipliers(
_ERC721Data,
tokenIds,
multipliers
);
}
function resetUserAvgMultiplier(address user)
external
virtual
onlyPoolAdmin
nonReentrant
{
MintableERC721Logic.executeResetUserAvgMultiplier(_ERC721Data, user);
}
/// @inheritdoc IAuctionableERC721
function getAuctionData(uint256 tokenId)
external
view
override
returns (DataTypes.Auction memory auction)
{
bool _isAuctioned = MintableERC721Logic.isAuctioned(
_ERC721Data,
POOL,
tokenId
);
if (_isAuctioned) {
auction = _ERC721Data.auctions[tokenId];
}
}
/// @inheritdoc IAtomicCollateralizableERC721
function getTraitMultiplier(uint256 tokenId)
external
view
override
returns (uint256)
{
return
MintableERC721Logic.getTraitMultiplier(
_ERC721Data.traitsMultipliers[tokenId]
);
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
external
view
virtual
override(IERC165)
returns (bool)
{
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Enumerable).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
interfaceId == type(IERC165).interfaceId;
}
/**
* @dev See {IERC721Enumerable-tokenOfOwnerByIndex}.
*/
function tokenOfOwnerByIndex(address owner, uint256 index)
external
view
virtual
override
returns (uint256)
{
require(
index < balanceOf(owner),
"ERC721Enumerable: owner index out of bounds"
);
return _ERC721Data.ownedTokens[owner][index];
}
/**
* @dev See {IERC721Enumerable-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _ERC721Data.allTokens.length;
}
/**
* @dev See {IERC721Enumerable-tokenByIndex}.
*/
function tokenByIndex(uint256 index)
external
view
virtual
override
returns (uint256)
{
require(
index < totalSupply(),
"ERC721Enumerable: global index out of bounds"
);
return _ERC721Data.allTokens[index];
}
/**
* @notice Rescue ERC20 Token.
* @param token The address of the token
* @param to The address of the recipient
* @param amount The amount being rescued
**/
function rescueERC20(
address token,
address to,
uint256 amount
) external onlyPoolAdmin {
MintableERC721Logic.executeRescueERC20(token, to, amount);
}
/**
* @notice Rescue ERC721 Token.
* @param token The address of the token
* @param to The address of the recipient
* @param ids The ids of the tokens being rescued
**/
function rescueERC721(
address token,
address to,
uint256[] calldata ids
) external onlyPoolAdmin {
MintableERC721Logic.executeRescueERC721(
_ERC721Data.underlyingAsset,
token,
to,
ids
);
}
/**
* @notice Rescue ERC1155 Token.
* @param token The address of the token
* @param to The address of the recipient
* @param ids The ids of the tokens being rescued
* @param amounts The amount of NFTs being rescued for a specific id.
* @param data The data of the tokens that is being rescued. Usually this is 0.
**/
function rescueERC1155(
address token,
address to,
uint256[] calldata ids,
uint256[] calldata amounts,
bytes calldata data
) external onlyPoolAdmin {
MintableERC721Logic.executeRescueERC1155(token, to, ids, amounts, data);
}
/**
* @notice Executes airdrop.
* @param airdropContract The address of the airdrop contract
* @param airdropParams Third party airdrop abi data. You need to get this from the third party airdrop.
**/
function executeAirdrop(
address airdropContract,
bytes calldata airdropParams
) external onlyPoolAdmin {
MintableERC721Logic.executeAirdrop(airdropContract, airdropParams);
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import {ApeCoinStaking} from "../../../dependencies/yoga-labs/ApeCoinStaking.sol";
import {IERC721} from "../../../dependencies/openzeppelin/contracts/IERC721.sol";
import {SafeERC20} from "../../../dependencies/openzeppelin/contracts/SafeERC20.sol";
import {IERC20} from "../../../dependencies/openzeppelin/contracts/IERC20.sol";
import "./MintableERC721Logic.sol";
import "../../../interfaces/IPool.sol";
import {DataTypes} from "../../libraries/types/DataTypes.sol";
import {PercentageMath} from "../../libraries/math/PercentageMath.sol";
import "../../../dependencies/openzeppelin/contracts/SafeCast.sol";
import "../../../interfaces/INToken.sol";
/**
* @title ApeStakingLogic library
*
* @notice Implements the base logic for ApeStaking
*/
library ApeStakingLogic {
using SafeERC20 for IERC20;
using PercentageMath for uint256;
using SafeCast for uint256;
uint256 constant BAYC_POOL_ID = 1;
uint256 constant MAYC_POOL_ID = 2;
uint256 constant BAKC_POOL_ID = 3;
struct APEStakingParameter {
uint256 unstakeIncentive;
}
event UnstakeApeIncentiveUpdated(uint256 oldValue, uint256 newValue);
/**
* @notice withdraw Ape coin staking position from ApeCoinStaking
* @param _apeCoinStaking ApeCoinStaking contract address
* @param poolId identify whether BAYC or MAYC paired with BAKC
* @param _nftPairs Array of Paired BAYC/MAYC NFT's with staked amounts
* @param _apeRecipient the receiver of ape coin
*/
function withdrawBAKC(
ApeCoinStaking _apeCoinStaking,
uint256 poolId,
ApeCoinStaking.PairNftWithdrawWithAmount[] memory _nftPairs,
address _apeRecipient
) external {
ApeCoinStaking.PairNftWithdrawWithAmount[]
memory _otherPairs = new ApeCoinStaking.PairNftWithdrawWithAmount[](
0
);
uint256 beforeBalance = _apeCoinStaking.apeCoin().balanceOf(
address(this)
);
if (poolId == BAYC_POOL_ID) {
_apeCoinStaking.withdrawBAKC(_nftPairs, _otherPairs);
} else {
_apeCoinStaking.withdrawBAKC(_otherPairs, _nftPairs);
}
uint256 afterBalance = _apeCoinStaking.apeCoin().balanceOf(
address(this)
);
_apeCoinStaking.apeCoin().safeTransfer(
_apeRecipient,
afterBalance - beforeBalance
);
}
/**
* @notice undate incentive percentage for unstakePositionAndRepay
* @param stakingParameter storage for Ape staking
* @param incentive new incentive percentage
*/
function executeSetUnstakeApeIncentive(
APEStakingParameter storage stakingParameter,
uint256 incentive
) external {
require(
incentive < PercentageMath.HALF_PERCENTAGE_FACTOR,
"Value Too High"
);
uint256 oldValue = stakingParameter.unstakeIncentive;
if (oldValue != incentive) {
stakingParameter.unstakeIncentive = incentive;
emit UnstakeApeIncentiveUpdated(oldValue, incentive);
}
}
struct UnstakeAndRepayParams {
IPool POOL;
ApeCoinStaking _apeCoinStaking;
address _underlyingAsset;
uint256 poolId;
uint256 tokenId;
address incentiveReceiver;
address bakcNToken;
}
/**
* @notice Unstake Ape coin staking position and repay user debt
* @param _owners The state of ownership for nToken
* @param stakingParameter storage for Ape staking
* @param params The additional parameters needed to execute this function
*/
function executeUnstakePositionAndRepay(
mapping(uint256 => address) storage _owners,
APEStakingParameter storage stakingParameter,
UnstakeAndRepayParams memory params
) external {
if (
IERC721(params._underlyingAsset).ownerOf(params.tokenId) !=
address(this)
) {
return;
}
address positionOwner = _owners[params.tokenId];
IERC20 _apeCoin = params._apeCoinStaking.apeCoin();
uint256 balanceBefore = _apeCoin.balanceOf(address(this));
//1 unstake all position
{
//1.1 unstake Main pool position
(uint256 stakedAmount, ) = params._apeCoinStaking.nftPosition(
params.poolId,
params.tokenId
);
if (stakedAmount > 0) {
ApeCoinStaking.SingleNft[]
memory nfts = new ApeCoinStaking.SingleNft[](1);
nfts[0].tokenId = params.tokenId.toUint32();
nfts[0].amount = stakedAmount.toUint224();
if (params.poolId == BAYC_POOL_ID) {
params._apeCoinStaking.withdrawBAYC(nfts, address(this));
} else {
params._apeCoinStaking.withdrawMAYC(nfts, address(this));
}
}
//1.2 unstake bakc pool position
(uint256 bakcTokenId, bool isPaired) = params
._apeCoinStaking
.mainToBakc(params.poolId, params.tokenId);
if (isPaired) {
(stakedAmount, ) = params._apeCoinStaking.nftPosition(
BAKC_POOL_ID,
bakcTokenId
);
if (stakedAmount > 0) {
ApeCoinStaking.PairNftWithdrawWithAmount[]
memory _nftPairs = new ApeCoinStaking.PairNftWithdrawWithAmount[](
1
);
_nftPairs[0].mainTokenId = params.tokenId.toUint32();
_nftPairs[0].bakcTokenId = bakcTokenId.toUint32();
_nftPairs[0].amount = stakedAmount.toUint184();
_nftPairs[0].isUncommit = true;
ApeCoinStaking.PairNftWithdrawWithAmount[]
memory _otherPairs = new ApeCoinStaking.PairNftWithdrawWithAmount[](
0
);
uint256 bakcBeforeBalance = _apeCoin.balanceOf(
params.bakcNToken
);
if (params.poolId == BAYC_POOL_ID) {
params._apeCoinStaking.withdrawBAKC(
_nftPairs,
_otherPairs
);
} else {
params._apeCoinStaking.withdrawBAKC(
_otherPairs,
_nftPairs
);
}
uint256 bakcAfterBalance = _apeCoin.balanceOf(
params.bakcNToken
);
uint256 balanceDiff = bakcAfterBalance - bakcBeforeBalance;
if (balanceDiff > 0) {
address bakcOwner = INToken(params.bakcNToken).ownerOf(
bakcTokenId
);
_apeCoin.safeTransferFrom(
params.bakcNToken,
bakcOwner,
balanceDiff
);
}
}
}
}
uint256 unstakedAmount = _apeCoin.balanceOf(address(this)) -
balanceBefore;
if (unstakedAmount == 0) {
return;
}
//2 send incentive to caller
if (params.incentiveReceiver != address(0)) {
uint256 unstakeIncentive = stakingParameter.unstakeIncentive;
if (unstakeIncentive > 0) {
uint256 incentiveAmount = unstakedAmount.percentMul(
unstakeIncentive
);
_apeCoin.safeTransfer(
params.incentiveReceiver,
incentiveAmount
);
unstakedAmount = unstakedAmount - incentiveAmount;
}
}
//3 repay and supply
params.POOL.repayAndSupply(
params._underlyingAsset,
positionOwner,
unstakedAmount
);
}
/**
* @notice get user total ape staking position
* @param userState The user state of nToken
* @param ownedTokens The ownership mapping state of nNtoken
* @param user User address
* @param poolId identify whether BAYC pool or MAYC pool
* @param _apeCoinStaking ApeCoinStaking contract address
*/
function getUserTotalStakingAmount(
mapping(address => UserState) storage userState,
mapping(address => mapping(uint256 => uint256)) storage ownedTokens,
address _underlyingAsset,
address user,
uint256 poolId,
ApeCoinStaking _apeCoinStaking
) external view returns (uint256) {
uint256 totalBalance = uint256(userState[user].balance);
uint256 totalAmount;
for (uint256 index = 0; index < totalBalance; index++) {
uint256 tokenId = ownedTokens[user][index];
totalAmount += getTokenIdStakingAmount(
_underlyingAsset,
poolId,
_apeCoinStaking,
tokenId
);
}
return totalAmount;
}
/**
* @notice get ape staking position for a tokenId
* @param poolId identify whether BAYC pool or MAYC pool
* @param _apeCoinStaking ApeCoinStaking contract address
* @param tokenId specified the tokenId for the position
*/
function getTokenIdStakingAmount(
address _underlyingAsset,
uint256 poolId,
ApeCoinStaking _apeCoinStaking,
uint256 tokenId
) public view returns (uint256) {
if (IERC721(_underlyingAsset).ownerOf(tokenId) != address(this)) {
return 0;
}
(uint256 apeStakedAmount, ) = _apeCoinStaking.nftPosition(
poolId,
tokenId
);
uint256 apeReward = _apeCoinStaking.pendingRewards(
poolId,
address(this),
tokenId
);
(uint256 bakcTokenId, bool isPaired) = _apeCoinStaking.mainToBakc(
poolId,
tokenId
);
if (isPaired) {
(uint256 bakcStakedAmount, ) = _apeCoinStaking.nftPosition(
BAKC_POOL_ID,
bakcTokenId
);
apeStakedAmount += bakcStakedAmount;
}
return apeStakedAmount + apeReward;
}
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import {SafeCast} from "../../../dependencies/openzeppelin/contracts/SafeCast.sol";
import {WadRayMath} from "../../libraries/math/WadRayMath.sol";
import "../../../interfaces/IRewardController.sol";
import "../../libraries/types/DataTypes.sol";
import "../../../interfaces/IPool.sol";
import "../../../interfaces/INToken.sol";
import {Errors} from "../../libraries/helpers/Errors.sol";
import {SafeERC20} from "../../../dependencies/openzeppelin/contracts/SafeERC20.sol";
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 {IDelegationRegistry} from "../../../dependencies/delegation/IDelegationRegistry.sol";
struct UserState {
uint64 balance;
uint64 collateralizedBalance;
uint128 additionalData;
uint256 avgMultiplier;
}
struct MintableERC721Data {
// Token name
string name;
// Token symbol
string symbol;
// Mapping from token ID to owner address
mapping(uint256 => address) owners;
// Mapping from owner to list of owned token IDs
mapping(address => mapping(uint256 => uint256)) ownedTokens;
// Mapping from token ID to index of the owner tokens list
mapping(uint256 => uint256) ownedTokensIndex;
// Array with all token ids, used for enumeration
uint256[] allTokens;
// Mapping from token id to position in the allTokens array
mapping(uint256 => uint256) allTokensIndex;
// Map of users address and their state data (userAddress => userStateData)
mapping(address => UserState) userState;
// Mapping from token ID to approved address
mapping(uint256 => address) tokenApprovals;
// Mapping from owner to operator approvals
mapping(address => mapping(address => bool)) operatorApprovals;
// Map of allowances (delegator => delegatee => allowanceAmount)
mapping(address => mapping(address => uint256)) allowances;
IRewardController rewardController;
uint64 balanceLimit;
mapping(uint256 => bool) isUsedAsCollateral;
mapping(uint256 => DataTypes.Auction) auctions;
address underlyingAsset;
bool isTraitBoosted;
mapping(uint256 => uint256) traitsMultipliers;
mapping(uint256 => address) tokenDelegations;
}
struct LocalVars {
uint64 oldBalance;
uint64 oldCollateralizedBalance;
uint256 collateralizedBalanceDelta;
uint256 multiplierDelta;
}
/**
* @title MintableERC721 library
*
* @notice Implements the base logic for MintableERC721
*/
library MintableERC721Logic {
using SafeCast for uint256;
using SafeCast for int256;
/**
* @dev This constant represents the maximum trait multiplier that a single tokenId can have
* A value of 20e18 results in 20x of price
*/
uint256 internal constant MAX_TRAIT_MULTIPLIER = 20e18;
/**
* @dev This constant represents the minimum trait multiplier that a single tokenId can have
* A value of 1e18 results in no price multiplier
*/
uint256 internal constant MIN_TRAIT_MULTIPLIER = 0e18;
/**
* @dev Emitted during rescueERC20()
* @param token The address of the token
* @param to The address of the recipient
* @param amount The amount being rescued
**/
event RescueERC20(
address indexed token,
address indexed to,
uint256 amount
);
/**
* @dev Emitted during rescueERC721()
* @param token The address of the token
* @param to The address of the recipient
* @param ids The ids of the tokens being rescued
**/
event RescueERC721(
address indexed token,
address indexed to,
uint256[] ids
);
/**
* @dev Emitted during RescueERC1155()
* @param token The address of the token
* @param to The address of the recipient
* @param ids The ids of the tokens being rescued
* @param amounts The amount of NFTs being rescued for a specific id.
* @param data The data of the tokens that is being rescued. Usually this is 0.
**/
event RescueERC1155(
address indexed token,
address indexed to,
uint256[] ids,
uint256[] amounts,
bytes data
);
/**
* @dev Emitted during executeAirdrop()
* @param airdropContract The address of the airdrop contract
**/
event ExecuteAirdrop(address indexed airdropContract);
/**
* @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 Emitted when trait multiplier got updated
*/
event TraitMultiplierSet(
address indexed owner,
uint256 indexed tokenId,
uint256 multiplier
);
/**
* @dev Emitted when user's avg multiplier got updated
*/
event AvgMultiplierUpdated(address indexed owner, uint256 avgMultiplier);
using SafeERC20 for IERC20;
function executeTransfer(
MintableERC721Data storage erc721Data,
IPool POOL,
bool ATOMIC_PRICING,
address DELEGATION_REGISTRY,
address from,
address to,
uint256 tokenId
) public {
require(
erc721Data.owners[tokenId] == from,
"ERC721: transfer from incorrect owner"
);
require(to != address(0), "ERC721: transfer to the zero address");
require(
!isAuctioned(erc721Data, POOL, tokenId),
Errors.TOKEN_IN_AUCTION
);
_beforeTokenTransfer(erc721Data, from, to, tokenId);
// Clear approvals from the previous owner
_approve(erc721Data, address(0), tokenId);
uint64 oldSenderBalance = erc721Data.userState[from].balance;
erc721Data.userState[from].balance = oldSenderBalance - 1;
uint64 oldRecipientBalance = erc721Data.userState[to].balance;
uint64 newRecipientBalance = oldRecipientBalance + 1;
_checkBalanceLimit(erc721Data, ATOMIC_PRICING, newRecipientBalance);
erc721Data.userState[to].balance = newRecipientBalance;
erc721Data.owners[tokenId] = to;
if (from != to && erc721Data.auctions[tokenId].startTime > 0) {
delete erc721Data.auctions[tokenId];
}
address tokenDelegationAddress = erc721Data.tokenDelegations[tokenId];
if (from != to && tokenDelegationAddress != address(0)) {
_updateTokenDelegation(
erc721Data,
DELEGATION_REGISTRY,
tokenDelegationAddress,
tokenId,
false
);
}
IRewardController rewardControllerLocal = erc721Data.rewardController;
if (address(rewardControllerLocal) != address(0)) {
uint256 oldTotalSupply = erc721Data.allTokens.length;
rewardControllerLocal.handleAction(
from,
oldTotalSupply,
oldSenderBalance
);
if (from != to) {
rewardControllerLocal.handleAction(
to,
oldTotalSupply,
oldRecipientBalance
);
}
}
emit Transfer(from, to, tokenId);
}
function executeTransferCollateralizable(
MintableERC721Data storage erc721Data,
IPool POOL,
bool ATOMIC_PRICING,
address DELEGATION_REGISTRY,
address from,
address to,
uint256 tokenId
) external returns (bool isUsedAsCollateral_) {
isUsedAsCollateral_ = erc721Data.isUsedAsCollateral[tokenId];
if (from != to && isUsedAsCollateral_) {
if (_shouldUpdateUserAvgMultiplier(erc721Data, ATOMIC_PRICING)) {
_executeUpdateUserAvgMultiplier(
erc721Data,
from,
-getTraitMultiplier(erc721Data.traitsMultipliers[tokenId])
.toInt256(),
-1
);
}
erc721Data.userState[from].collateralizedBalance -= 1;
delete erc721Data.isUsedAsCollateral[tokenId];
}
executeTransfer(
erc721Data,
POOL,
ATOMIC_PRICING,
DELEGATION_REGISTRY,
from,
to,
tokenId
);
}
function executeSetIsUsedAsCollateral(
MintableERC721Data storage erc721Data,
IPool POOL,
bool ATOMIC_PRICING,
uint256 tokenId,
bool useAsCollateral,
address sender
) public returns (bool) {
if (erc721Data.isUsedAsCollateral[tokenId] == useAsCollateral)
return false;
address owner = erc721Data.owners[tokenId];
require(owner == sender, "not owner");
if (!useAsCollateral) {
require(
!isAuctioned(erc721Data, POOL, tokenId),
Errors.TOKEN_IN_AUCTION
);
}
if (_shouldUpdateUserAvgMultiplier(erc721Data, ATOMIC_PRICING)) {
_executeUpdateUserAvgMultiplier(
erc721Data,
owner,
useAsCollateral
? getTraitMultiplier(erc721Data.traitsMultipliers[tokenId])
.toInt256()
: -getTraitMultiplier(erc721Data.traitsMultipliers[tokenId])
.toInt256(),
useAsCollateral ? int256(1) : int256(-1)
);
}
uint64 collateralizedBalance = erc721Data
.userState[owner]
.collateralizedBalance;
erc721Data.isUsedAsCollateral[tokenId] = useAsCollateral;
collateralizedBalance = useAsCollateral
? collateralizedBalance + 1
: collateralizedBalance - 1;
erc721Data
.userState[owner]
.collateralizedBalance = collateralizedBalance;
return true;
}
function executeBatchSetIsUsedAsCollateral(
MintableERC721Data storage erc721Data,
IPool POOL,
bool ATOMIC_PRICING,
uint256[] calldata tokenIds,
bool useAsCollateral,
address sender
)
external
returns (
uint256 oldCollateralizedBalance,
uint256 newCollateralizedBalance
)
{
oldCollateralizedBalance = erc721Data
.userState[sender]
.collateralizedBalance;
for (uint256 index = 0; index < tokenIds.length; index++) {
executeSetIsUsedAsCollateral(
erc721Data,
POOL,
ATOMIC_PRICING,
tokenIds[index],
useAsCollateral,
sender
);
}
newCollateralizedBalance = erc721Data
.userState[sender]
.collateralizedBalance;
}
function executeMintMultiple(
MintableERC721Data storage erc721Data,
bool ATOMIC_PRICING,
address to,
DataTypes.ERC721SupplyParams[] calldata tokenData
) external returns (uint64, uint64) {
require(to != address(0), "ERC721: mint to the zero address");
LocalVars memory vars = _cache(erc721Data, to);
uint256 oldTotalSupply = erc721Data.allTokens.length;
bool shouldUpdateUserAvgMultiplier = _shouldUpdateUserAvgMultiplier(
erc721Data,
ATOMIC_PRICING
);
for (uint256 index = 0; index < tokenData.length; index++) {
uint256 tokenId = tokenData[index].tokenId;
require(
!_exists(erc721Data, tokenId),
"ERC721: token already minted"
);
_addTokenToAllTokensEnumeration(
erc721Data,
tokenId,
oldTotalSupply + index
);
_addTokenToOwnerEnumeration(
erc721Data,
to,
tokenId,
vars.oldBalance + index
);
erc721Data.owners[tokenId] = to;
if (
tokenData[index].useAsCollateral &&
!erc721Data.isUsedAsCollateral[tokenId]
) {
erc721Data.isUsedAsCollateral[tokenId] = true;
vars.collateralizedBalanceDelta++;
if (shouldUpdateUserAvgMultiplier) {
vars.multiplierDelta += getTraitMultiplier(
erc721Data.traitsMultipliers[tokenId]
);
}
}
emit Transfer(address(0), to, tokenId);
}
if (shouldUpdateUserAvgMultiplier) {
_executeUpdateUserAvgMultiplier(
erc721Data,
to,
vars.multiplierDelta.toInt256(),
vars.collateralizedBalanceDelta.toInt256()
);
}
uint64 newCollateralizedBalance = vars.oldCollateralizedBalance +
vars.collateralizedBalanceDelta.toUint64();
erc721Data
.userState[to]
.collateralizedBalance = newCollateralizedBalance;
uint64 newBalance = vars.oldBalance + uint64(tokenData.length);
_checkBalanceLimit(erc721Data, ATOMIC_PRICING, newBalance);
erc721Data.userState[to].balance = newBalance;
// calculate incentives
IRewardController rewardControllerLocal = erc721Data.rewardController;
if (address(rewardControllerLocal) != address(0)) {
rewardControllerLocal.handleAction(
to,
oldTotalSupply,
vars.oldBalance
);
}
return (vars.oldCollateralizedBalance, newCollateralizedBalance);
}
function executeBurnMultiple(
MintableERC721Data storage erc721Data,
IPool POOL,
bool ATOMIC_PRICING,
address DELEGATION_REGISTRY,
address user,
uint256[] calldata tokenIds
) external returns (uint64, uint64) {
LocalVars memory vars = _cache(erc721Data, user);
uint256 oldTotalSupply = erc721Data.allTokens.length;
bool shouldUpdateUserAvgMultiplier = _shouldUpdateUserAvgMultiplier(
erc721Data,
ATOMIC_PRICING
);
for (uint256 index = 0; index < tokenIds.length; index++) {
// uint256 tokenId = tokenIds[index];
address owner = erc721Data.owners[tokenIds[index]];
require(owner == user, "not the owner of Ntoken");
require(
!isAuctioned(erc721Data, POOL, tokenIds[index]),
Errors.TOKEN_IN_AUCTION
);
_removeTokenFromAllTokensEnumeration(
erc721Data,
tokenIds[index],
oldTotalSupply - index
);
_removeTokenFromOwnerEnumeration(
erc721Data,
user,
tokenIds[index],
vars.oldBalance - index
);
// Clear approvals
_approve(erc721Data, address(0), tokenIds[index]);
if (erc721Data.auctions[tokenIds[index]].startTime > 0) {
delete erc721Data.auctions[tokenIds[index]];
}
if (erc721Data.isUsedAsCollateral[tokenIds[index]]) {
delete erc721Data.isUsedAsCollateral[tokenIds[index]];
vars.collateralizedBalanceDelta += 1;
if (shouldUpdateUserAvgMultiplier) {
vars.multiplierDelta += getTraitMultiplier(
erc721Data.traitsMultipliers[tokenIds[index]]
);
}
}
address tokenDelegationAddress = erc721Data.tokenDelegations[
tokenIds[index]
];
if (tokenDelegationAddress != address(0)) {
_updateTokenDelegation(
erc721Data,
DELEGATION_REGISTRY,
tokenDelegationAddress,
tokenIds[index],
false
);
}
delete erc721Data.owners[tokenIds[index]];
emit Transfer(owner, address(0), tokenIds[index]);
}
erc721Data.userState[user].balance =
vars.oldBalance -
uint64(tokenIds.length);
if (shouldUpdateUserAvgMultiplier) {
_executeUpdateUserAvgMultiplier(
erc721Data,
user,
-vars.multiplierDelta.toInt256(),
-vars.collateralizedBalanceDelta.toInt256()
);
}
uint64 newCollateralizedBalance = vars.oldCollateralizedBalance -
vars.collateralizedBalanceDelta.toUint64();
erc721Data
.userState[user]
.collateralizedBalance = newCollateralizedBalance;
// calculate incentives
IRewardController rewardControllerLocal = erc721Data.rewardController;
if (address(rewardControllerLocal) != address(0)) {
rewardControllerLocal.handleAction(
user,
oldTotalSupply,
vars.oldBalance
);
}
return (vars.oldCollateralizedBalance, newCollateralizedBalance);
}
function executeUpdateTokenDelegation(
MintableERC721Data storage erc721Data,
address delegationRegistry,
address delegate,
uint256 tokenId,
bool value
) external {
_updateTokenDelegation(
erc721Data,
delegationRegistry,
delegate,
tokenId,
value
);
}
function _updateTokenDelegation(
MintableERC721Data storage erc721Data,
address delegationRegistry,
address delegate,
uint256 tokenId,
bool value
) internal {
if (value) {
erc721Data.tokenDelegations[tokenId] = delegate;
} else {
delete erc721Data.tokenDelegations[tokenId];
}
IDelegationRegistry(delegationRegistry).delegateForToken(
delegate,
erc721Data.underlyingAsset,
tokenId,
value
);
}
function executeApprove(
MintableERC721Data storage erc721Data,
address to,
uint256 tokenId
) external {
_approve(erc721Data, to, tokenId);
}
function _approve(
MintableERC721Data storage erc721Data,
address to,
uint256 tokenId
) private {
erc721Data.tokenApprovals[tokenId] = to;
emit Approval(erc721Data.owners[tokenId], to, tokenId);
}
function executeApprovalForAll(
MintableERC721Data storage erc721Data,
address owner,
address operator,
bool approved
) external {
require(owner != operator, "ERC721: approve to caller");
erc721Data.operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
function executeStartAuction(
MintableERC721Data storage erc721Data,
IPool POOL,
uint256 tokenId
) external {
require(
!isAuctioned(erc721Data, POOL, tokenId),
Errors.AUCTION_ALREADY_STARTED
);
require(
_exists(erc721Data, tokenId),
"ERC721: startAuction for nonexistent token"
);
erc721Data.auctions[tokenId] = DataTypes.Auction({
startTime: block.timestamp
});
}
function executeEndAuction(
MintableERC721Data storage erc721Data,
IPool POOL,
uint256 tokenId
) external {
require(
isAuctioned(erc721Data, POOL, tokenId),
Errors.AUCTION_NOT_STARTED
);
require(
_exists(erc721Data, tokenId),
"ERC721: endAuction for nonexistent token"
);
delete erc721Data.auctions[tokenId];
}
function _executeUpdateUserAvgMultiplier(
MintableERC721Data storage erc721Data,
address owner,
int256 multiplierDelta,
int256 collateralizedBalanceDelta
) internal {
if (owner == address(0)) {
return;
}
uint256 oldAvgMultiplier = getTraitMultiplier(
erc721Data.userState[owner].avgMultiplier
);
uint256 collateralizedBalance = uint256(
erc721Data.userState[owner].collateralizedBalance
);
int256 numerator = (oldAvgMultiplier * collateralizedBalance)
.toInt256() + multiplierDelta;
int256 denominator = collateralizedBalance.toInt256() +
collateralizedBalanceDelta;
uint256 newAvgMultiplier = numerator != 0 && denominator != 0
? (numerator / denominator).toUint256()
: WadRayMath.WAD;
if (oldAvgMultiplier != newAvgMultiplier) {
erc721Data.userState[owner].avgMultiplier = newAvgMultiplier;
emit AvgMultiplierUpdated(owner, newAvgMultiplier);
}
}
function executeResetUserAvgMultiplier(
MintableERC721Data storage erc721Data,
address user
) external returns (bool notEqual) {
uint256 balance = erc721Data.userState[user].balance;
uint256 oldAvgMultiplier = getTraitMultiplier(
erc721Data.userState[user].avgMultiplier
);
uint256 totalMultiplier;
for (uint256 i = 0; i < balance; i += 1) {
uint256 tokenId = erc721Data.ownedTokens[user][i];
if (!erc721Data.isUsedAsCollateral[tokenId]) {
continue;
}
totalMultiplier += getTraitMultiplier(
erc721Data.traitsMultipliers[tokenId]
);
}
uint256 collateralizedBalance = erc721Data
.userState[user]
.collateralizedBalance;
uint256 newAvgMultiplier = totalMultiplier != 0 &&
collateralizedBalance != 0
? totalMultiplier / collateralizedBalance
: WadRayMath.WAD;
notEqual = oldAvgMultiplier != newAvgMultiplier;
if (notEqual) {
erc721Data.userState[user].avgMultiplier = newAvgMultiplier;
}
}
function executeSetTraitsMultipliers(
MintableERC721Data storage erc721Data,
uint256[] calldata tokenIds,
uint256[] calldata multipliers
) external {
require(
tokenIds.length == multipliers.length,
Errors.INCONSISTENT_PARAMS_LENGTH
);
for (uint256 i = 0; i < tokenIds.length; i++) {
uint256 tokenId = tokenIds[i];
uint256 multiplier = multipliers[i];
_checkTraitMultiplier(multiplier);
uint256 oldMultiplier = getTraitMultiplier(
erc721Data.traitsMultipliers[tokenId]
);
uint256 newMultiplier = getTraitMultiplier(multiplier);
erc721Data.traitsMultipliers[tokenId] = newMultiplier;
address owner = erc721Data.owners[tokenId];
emit TraitMultiplierSet(owner, tokenId, newMultiplier);
if (
owner == address(0) || !erc721Data.isUsedAsCollateral[tokenId]
) {
continue;
}
int256 multiplierDelta = newMultiplier.toInt256() -
oldMultiplier.toInt256();
_executeUpdateUserAvgMultiplier(
erc721Data,
owner,
multiplierDelta,
0
);
}
if (!erc721Data.isTraitBoosted) erc721Data.isTraitBoosted = true;
}
function _shouldUpdateUserAvgMultiplier(
MintableERC721Data storage erc721Data,
bool ATOMIC_PRICING
) private view returns (bool) {
return !ATOMIC_PRICING && erc721Data.isTraitBoosted;
}
function _checkBalanceLimit(
MintableERC721Data storage erc721Data,
bool ATOMIC_PRICING,
uint64 balance
) private view {
if (ATOMIC_PRICING) {
uint64 balanceLimit = erc721Data.balanceLimit;
require(
balanceLimit == 0 || balance <= balanceLimit,
Errors.NTOKEN_BALANCE_EXCEEDED
);
}
}
function _checkTraitMultiplier(uint256 multiplier) private pure {
require(
multiplier >= MIN_TRAIT_MULTIPLIER &&
multiplier < MAX_TRAIT_MULTIPLIER,
Errors.INVALID_AMOUNT
);
}
function _exists(MintableERC721Data storage erc721Data, uint256 tokenId)
private
view
returns (bool)
{
return erc721Data.owners[tokenId] != address(0);
}
function _cache(MintableERC721Data storage erc721Data, address user)
private
view
returns (LocalVars memory vars)
{
vars.oldBalance = erc721Data.userState[user].balance;
vars.oldCollateralizedBalance = erc721Data
.userState[user]
.collateralizedBalance;
}
function getTraitMultiplier(uint256 multiplier)
internal
pure
returns (uint256)
{
return multiplier != 0 ? multiplier : WadRayMath.WAD;
}
function isAuctioned(
MintableERC721Data storage erc721Data,
IPool POOL,
uint256 tokenId
) public view returns (bool) {
return
erc721Data.auctions[tokenId].startTime >
POOL
.getUserConfiguration(erc721Data.owners[tokenId])
.auctionValidityTime;
}
function executeRescueERC20(
address token,
address to,
uint256 amount
) external {
IERC20(token).safeTransfer(to, amount);
emit RescueERC20(token, to, amount);
}
function executeRescueERC721(
address _underlyingAsset,
address token,
address to,
uint256[] calldata ids
) external {
require(
token != _underlyingAsset,
Errors.UNDERLYING_ASSET_CAN_NOT_BE_TRANSFERRED
);
for (uint256 i = 0; i < ids.length; i++) {
IERC721(token).safeTransferFrom(address(this), to, ids[i]);
}
emit RescueERC721(token, to, ids);
}
function executeRescueERC1155(
address token,
address to,
uint256[] calldata ids,
uint256[] calldata amounts,
bytes calldata data
) external {
IERC1155(token).safeBatchTransferFrom(
address(this),
to,
ids,
amounts,
data
);
emit RescueERC1155(token, to, ids, amounts, data);
}
function executeAirdrop(
address airdropContract,
bytes calldata airdropParams
) external {
require(
airdropContract != address(0),
Errors.INVALID_AIRDROP_CONTRACT_ADDRESS
);
require(airdropParams.length >= 4, Errors.INVALID_AIRDROP_PARAMETERS);
// call project airdrop contract
Address.functionCall(
airdropContract,
airdropParams,
Errors.CALL_AIRDROP_METHOD_FAILED
);
emit ExecuteAirdrop(airdropContract);
}
/**
* @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(
MintableERC721Data storage erc721Data,
address from,
address to,
uint256 tokenId
) private {
if (from == address(0)) {
uint256 length = erc721Data.allTokens.length;
_addTokenToAllTokensEnumeration(erc721Data, tokenId, length);
} else if (from != to) {
uint256 userBalance = erc721Data.userState[from].balance;
_removeTokenFromOwnerEnumeration(
erc721Data,
from,
tokenId,
userBalance
);
}
if (to == address(0)) {
uint256 length = erc721Data.allTokens.length;
_removeTokenFromAllTokensEnumeration(erc721Data, tokenId, length);
} else if (to != from) {
uint256 length = erc721Data.userState[to].balance;
_addTokenToOwnerEnumeration(erc721Data, to, tokenId, length);
}
}
/**
* @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(
MintableERC721Data storage erc721Data,
address to,
uint256 tokenId,
uint256 length
) private {
erc721Data.ownedTokens[to][length] = tokenId;
erc721Data.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(
MintableERC721Data storage erc721Data,
uint256 tokenId,
uint256 length
) private {
erc721Data.allTokensIndex[tokenId] = length;
erc721Data.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(
MintableERC721Data storage erc721Data,
address from,
uint256 tokenId,
uint256 userBalance
) 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 = userBalance - 1;
uint256 tokenIndex = erc721Data.ownedTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary
if (tokenIndex != lastTokenIndex) {
uint256 lastTokenId = erc721Data.ownedTokens[from][lastTokenIndex];
erc721Data.ownedTokens[from][tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
erc721Data.ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
}
// This also deletes the contents at the last position of the array
delete erc721Data.ownedTokensIndex[tokenId];
delete erc721Data.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(
MintableERC721Data storage erc721Data,
uint256 tokenId,
uint256 length
) 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 = length - 1;
uint256 tokenIndex = erc721Data.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 = erc721Data.allTokens[lastTokenIndex];
erc721Data.allTokens[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
erc721Data.allTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
// This also deletes the contents at the last position of the array
delete erc721Data.allTokensIndex[tokenId];
erc721Data.allTokens.pop();
}
}{
"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": {
"contracts/protocol/tokenization/libraries/ApeStakingLogic.sol": {
"ApeStakingLogic": "0x869202f90533b8C0f60fcDC225Bc60779e6E9448"
},
"contracts/protocol/tokenization/libraries/MintableERC721Logic.sol": {
"MintableERC721Logic": "0xf5fC7493fed883E3Dc2e57bC24981EbBE0560D38"
}
}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"contract IPool","name":"pool","type":"address"},{"internalType":"address","name":"apeCoinStaking","type":"address"},{"internalType":"address","name":"delegateRegistry","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"approved","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":false,"internalType":"bool","name":"approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":false,"internalType":"uint256","name":"avgMultiplier","type":"uint256"}],"name":"AvgMultiplierUpdated","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"airdropContract","type":"address"}],"name":"ExecuteAirdrop","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"underlyingAsset","type":"address"},{"indexed":true,"internalType":"address","name":"pool","type":"address"},{"indexed":false,"internalType":"address","name":"incentivesController","type":"address"},{"indexed":false,"internalType":"string","name":"nTokenName","type":"string"},{"indexed":false,"internalType":"string","name":"nTokenSymbol","type":"string"},{"indexed":false,"internalType":"bytes","name":"params","type":"bytes"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256[]","name":"ids","type":"uint256[]"},{"indexed":false,"internalType":"uint256[]","name":"amounts","type":"uint256[]"},{"indexed":false,"internalType":"bytes","name":"data","type":"bytes"}],"name":"RescueERC1155","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"RescueERC20","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"token","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"RescueERC721","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"multiplier","type":"uint256"}],"name":"TraitMultiplierSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":true,"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[],"name":"DELEGATE_REGISTRY","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"NTOKEN_REVISION","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"UNDERLYING_ASSET_ADDRESS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"approve","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"avgMultiplierOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenIds","type":"uint256[]"},{"internalType":"bool","name":"useAsCollateral","type":"bool"},{"internalType":"address","name":"sender","type":"address"}],"name":"batchSetIsUsedAsCollateral","outputs":[{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"receiverOfUnderlying","type":"address"},{"internalType":"uint256[]","name":"tokenIds","type":"uint256[]"},{"components":[{"internalType":"uint48","name":"releaseTime","type":"uint48"},{"internalType":"enum DataTypes.TimeLockActionType","name":"actionType","type":"uint8"}],"internalType":"struct DataTypes.TimeLockParams","name":"timeLockParams","type":"tuple"}],"name":"burn","outputs":[{"internalType":"uint64","name":"","type":"uint64"},{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"_nfts","type":"uint256[]"},{"internalType":"address","name":"_recipient","type":"address"}],"name":"claimApeCoin","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint128","name":"mainTokenId","type":"uint128"},{"internalType":"uint128","name":"bakcTokenId","type":"uint128"}],"internalType":"struct ApeCoinStaking.PairNft[]","name":"_nftPairs","type":"tuple[]"},{"internalType":"address","name":"_recipient","type":"address"}],"name":"claimBAKC","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"timeLockV1","type":"address"},{"internalType":"uint256[]","name":"agreementIds","type":"uint256[]"}],"name":"claimUnderlying","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"collateralizedBalanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"delegate","type":"address"},{"internalType":"uint256[]","name":"tokenIds","type":"uint256[]"},{"internalType":"bool","name":"value","type":"bool"}],"name":"delegateForToken","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"tokenId","type":"uint32"},{"internalType":"uint224","name":"amount","type":"uint224"}],"internalType":"struct ApeCoinStaking.SingleNft[]","name":"_nfts","type":"tuple[]"}],"name":"depositApeCoin","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"mainTokenId","type":"uint32"},{"internalType":"uint32","name":"bakcTokenId","type":"uint32"},{"internalType":"uint184","name":"amount","type":"uint184"}],"internalType":"struct ApeCoinStaking.PairNftDepositWithAmount[]","name":"_nftPairs","type":"tuple[]"}],"name":"depositBAKC","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"endAuction","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"airdropContract","type":"address"},{"internalType":"bytes","name":"airdropParams","type":"bytes"}],"name":"executeAirdrop","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"getApeStaking","outputs":[{"internalType":"contract ApeCoinStaking","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getApproved","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getAuctionData","outputs":[{"components":[{"internalType":"uint256","name":"startTime","type":"uint256"}],"internalType":"struct DataTypes.Auction","name":"auction","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getBAKC","outputs":[{"internalType":"contract IERC721","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getIncentivesController","outputs":[{"internalType":"contract IRewardController","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"getTraitMultiplier","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"getUserApeStakingAmount","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getXTokenType","outputs":[{"internalType":"enum XTokenType","name":"","type":"uint8"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"contract IPool","name":"initializingPool","type":"address"},{"internalType":"address","name":"underlyingAsset","type":"address"},{"internalType":"contract IRewardController","name":"incentivesController","type":"address"},{"internalType":"string","name":"nTokenName","type":"string"},{"internalType":"string","name":"nTokenSymbol","type":"string"},{"internalType":"bytes","name":"params","type":"bytes"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"isAtomicPricing","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"isAuctioned","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"isUsedAsCollateral","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"onBehalfOf","type":"address"},{"components":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"bool","name":"useAsCollateral","type":"bool"}],"internalType":"struct DataTypes.ERC721SupplyParams[]","name":"tokenData","type":"tuple[]"}],"name":"mint","outputs":[{"internalType":"uint64","name":"","type":"uint64"},{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint256[]","name":"","type":"uint256[]"},{"internalType":"uint256[]","name":"","type":"uint256[]"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC1155BatchReceived","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"address","name":"","type":"address"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"bytes","name":"","type":"bytes"}],"name":"onERC1155Received","outputs":[{"internalType":"bytes4","name":"","type":"bytes4"}],"stateMutability":"pure","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":"tokenId","type":"uint256"}],"name":"ownerOf","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"},{"internalType":"uint256[]","name":"amounts","type":"uint256[]"},{"internalType":"bytes","name":"data","type":"bytes"}],"name":"rescueERC1155","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"rescueERC20","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"rescueERC721","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"resetUserAvgMultiplier","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"bytes","name":"_data","type":"bytes"}],"name":"safeTransferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"token","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"bool","name":"_approved","type":"bool"}],"name":"setApprovalForAllTo","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint64","name":"limit","type":"uint64"}],"name":"setBalanceLimit","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"contract IRewardController","name":"controller","type":"address"}],"name":"setIncentivesController","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"bool","name":"useAsCollateral","type":"bool"},{"internalType":"address","name":"sender","type":"address"}],"name":"setIsUsedAsCollateral","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256[]","name":"tokenIds","type":"uint256[]"},{"internalType":"uint256[]","name":"multipliers","type":"uint256[]"}],"name":"setTraitsMultipliers","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"incentive","type":"uint256"}],"name":"setUnstakeApeIncentive","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"startAuction","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"}],"name":"supportsInterface","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"index","type":"uint256"}],"name":"tokenByIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"uint256","name":"index","type":"uint256"}],"name":"tokenOfOwnerByIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"tokenURI","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"}],"name":"transferFrom","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transferOnLiquidation","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"target","type":"address"},{"internalType":"uint256","name":"tokenId","type":"uint256"},{"components":[{"internalType":"uint48","name":"releaseTime","type":"uint48"},{"internalType":"enum DataTypes.TimeLockActionType","name":"actionType","type":"uint8"}],"internalType":"struct DataTypes.TimeLockParams","name":"timeLockParams","type":"tuple"}],"name":"transferUnderlyingTo","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"tokenId","type":"uint256"},{"internalType":"address","name":"incentiveReceiver","type":"address"}],"name":"unstakePositionAndRepay","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"tokenId","type":"uint32"},{"internalType":"uint224","name":"amount","type":"uint224"}],"internalType":"struct ApeCoinStaking.SingleNft[]","name":"_nfts","type":"tuple[]"},{"internalType":"address","name":"_recipient","type":"address"}],"name":"withdrawApeCoin","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"mainTokenId","type":"uint32"},{"internalType":"uint32","name":"bakcTokenId","type":"uint32"},{"internalType":"uint184","name":"amount","type":"uint184"},{"internalType":"bool","name":"isUncommit","type":"bool"}],"internalType":"struct ApeCoinStaking.PairNftWithdrawWithAmount[]","name":"_nftPairs","type":"tuple[]"},{"internalType":"address","name":"_apeRecipient","type":"address"}],"name":"withdrawBAKC","outputs":[],"stateMutability":"nonpayable","type":"function"}]Contract Creation Code
610120604052600080553480156200001657600080fd5b506040516200542e3803806200542e83398101604081905262000039916200016d565b82828282600082826040518060400160405280600b81526020016a139513d2d15397d253541360aa1b8152506040518060400160405280600b81526020016a139513d2d15397d253541360aa1b81525084846001603481905550846001600160a01b0316630542975c6040518163ffffffff1660e01b8152600401602060405180830381865afa158015620000d2573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620000f89190620001c1565b6001600160a01b031660805260356200011285826200028d565b5060366200012184826200028d565b506001600160a01b0394851660a05290151560c052831660e0525050949094166101005250620003599650505050505050565b6001600160a01b03811681146200016a57600080fd5b50565b6000806000606084860312156200018357600080fd5b8351620001908162000154565b6020850151909350620001a38162000154565b6040850151909250620001b68162000154565b809150509250925092565b600060208284031215620001d457600080fd5b8151620001e18162000154565b9392505050565b634e487b7160e01b600052604160045260246000fd5b600181811c908216806200021357607f821691505b6020821081036200023457634e487b7160e01b600052602260045260246000fd5b50919050565b601f8211156200028857600081815260208120601f850160051c81016020861015620002635750805b601f850160051c820191505b8181101562000284578281556001016200026f565b5050505b505050565b81516001600160401b03811115620002a957620002a9620001e8565b620002c181620002ba8454620001fe565b846200023a565b602080601f831160018114620002f95760008415620002e05750858301515b600019600386901b1c1916600185901b17855562000284565b600085815260208120601f198616915b828110156200032a5788860151825594840194600190910190840162000309565b5085821015620003495787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b60805160a05160c05160e05161010051614f63620004cb6000396000818161053401528181610d6d01528181610fde0152818161112c01528181611c0501528181611cb001528181611ee8015281816121d3015281816122700152818161230a0152818161266b0152818161274f015281816127d90152818161285a01526132560152600081816106d40152818161190e0152818161342601526135ed01526000818161060101528181610e3d015281816120b0015281816133350152818161340501526135c5015260008181610a5301528181610e1501528181611107015281816113fc0152818161156e01528181611dcc01528181611e970152818161208e015281816123a60152818161243a015281816124d80152818161259d015281816126460152818161295e01528181612c5701528181612d4b01528181612fce0152818161312c01528181613231015281816133e401528181613527015261359d01526000612b020152614f636000f3fe608060405234801561001057600080fd5b50600436106103ba5760003560e01c80639420d32d116101f4578063c87b56dd1161011a578063e985e9c5116100ad578063f866c3191161007c578063f866c31914610958578063f9b95b431461096b578063fac2c0081461097e578063ff5effc01461099157600080fd5b8063e985e9c5146108d3578063eda2438c1461090f578063f23a6e6114610922578063f3fdfcd71461093557600080fd5b8063d7768ba7116100e9578063d7768ba714610887578063de41f1a91461089a578063e4596b3c146108ad578063e655dbd8146108c057600080fd5b8063c87b56dd14610826578063ccb4dd6114610839578063d0db1e231461084c578063d343852c1461087457600080fd5b8063a6fc2e8d11610192578063b88d4fde11610161578063b88d4fde146107cb578063b9a2de3a146107de578063bc197c81146107f1578063c716d80e1461081357600080fd5b8063a6fc2e8d14610781578063b16a19de14610794578063b2118a8d146107a5578063b5cb00ec146107b857600080fd5b80639ff903cd116101ce5780639ff903cd14610739578063a22cb4651461074c578063a54c6c4d1461075f578063a6627c8b1461077257600080fd5b80639420d32d1461070b57806395d51ce91461071e57806395d89b411461073157600080fd5b8063336d5e46116102e457806350ac06871161027757806375d264131161024657806375d26413146106b957806379c6cb3f146106ca5780638286eee2146106d25780638760f5e4146106f857600080fd5b806350ac0687146105ff57806360d6374e146106255780636352211e1461065e57806370a082311461068757600080fd5b806344f27e30116102b357806344f27e30146105a457806345f61e76146105c65780634f2c268f146105d95780634f6ccce7146105ec57600080fd5b8063336d5e46146105585780633421772f1461056b57806342842e0e1461057e57806343f8ac891461059157600080fd5b80631a6ed5ec1161035c5780632a933cc41161032b5780632a933cc4146104d95780632af5d473146104ec5780632f745c591461051f578063330b70241461053257600080fd5b80631a6ed5ec146104985780631e79a8c0146104a057806323b872dd146104b357806326b495a7146104c657600080fd5b8063081812fc11610398578063081812fc14610411578063095ea7b31461043c578063150b7a021461044f57806318160ddd1461048657600080fd5b806301ffc9a7146103bf578063065de74c146103e757806306fdde03146103fc575b600080fd5b6103d26103cd36600461368c565b6109a4565b60405190151581526020015b60405180910390f35b6103fa6103f53660046136b6565b610a11565b005b610404610aba565b6040516103de91906136f3565b61042461041f3660046136b6565b610b4f565b6040516001600160a01b0390911681526020016103de565b6103fa61044a36600461373b565b610be9565b61046d61045d3660046137fd565b630a85bd0160e11b949350505050565b6040516001600160e01b031990911681526020016103de565b603a545b6040519081526020016103de565b610424610d54565b6103d26104ae3660046138b9565b610de5565b6103fa6104c13660046138fb565b610eec565b6103fa6104d4366004613987565b610f34565b6103fa6104e73660046139f2565b610fc4565b6104ff6104fa366004613a78565b6110b1565b604080516001600160401b039384168152929091166020830152016103de565b61048a61052d36600461373b565b611237565b7f0000000000000000000000000000000000000000000000000000000000000000610424565b6103fa610566366004613b07565b6112e4565b6103fa610579366004613b24565b611319565b6103fa61058c3660046138fb565b61137d565b61048a61059f3660046136b6565b6113a0565b6105b76105b23660046136b6565b6113b8565b604051905181526020016103de565b6103fa6105d4366004613b78565b611496565b6103fa6105e7366004613b95565b611534565b61048a6105fa3660046136b6565b611745565b7f00000000000000000000000000000000000000000000000000000000000000006103d2565b61048a610633366004613b78565b6001600160a01b03166000908152603c6020526040902054600160401b90046001600160401b031690565b61042461066c3660046136b6565b6000908152603760205260409020546001600160a01b031690565b61048a610695366004613b78565b6001600160a01b03166000908152603c60205260409020546001600160401b031690565b6040546001600160a01b0316610424565b61048a609581565b7f0000000000000000000000000000000000000000000000000000000000000000610424565b6103fa610706366004613bd4565b6117d9565b6103fa6107193660046136b6565b6119db565b6103fa61072c366004613c7c565b611a5f565b610404611aa2565b6103fa610747366004613cc3565b611ab4565b6103fa61075a366004613d81565b611b3b565b6103fa61076d366004613dba565b611bc6565b60046040516103de9190613e4a565b61048a61078f366004613b78565b611c70565b6043546001600160a01b0316610424565b6103fa6107b33660046138fb565b611d40565b6103d26107c63660046136b6565b611d97565b6103fa6107d93660046137fd565b611e37565b6103fa6107ec3660046136b6565b611e55565b61046d6107ff366004613cc3565b63bc197c8160e01b98975050505050505050565b6103fa610821366004613e64565b611ec1565b6104046108343660046136b6565b611f4f565b6103fa610847366004613eaf565b611fc1565b61085f61085a366004613f07565b612049565b604080519283526020830191909152016103de565b6103fa610882366004613f63565b612137565b6103fa610895366004613fa3565b612175565b6103fa6108a8366004614076565b61257e565b6103fa6108bb3660046140df565b612728565b6103fa6108ce366004613b78565b612788565b6103d26108e1366004614116565b6001600160a01b039182166000908152603e6020908152604080832093909416825291909152205460ff1690565b6103fa61091d366004614144565b6127b2565b61046d610930366004614185565b612810565b6103d26109433660046136b6565b60009081526041602052604090205460ff1690565b6103fa6109663660046138fb565b612823565b6103fa6109793660046140df565b612840565b61048a61098c366004613b78565b6128e9565b6104ff61099f366004614200565b61290e565b60006001600160e01b031982166380ac58cd60e01b14806109d557506001600160e01b0319821663780e9d6360e01b145b806109f057506001600160e01b03198216635b5e139f60e01b145b80610a0b57506001600160e01b031982166301ffc9a760e01b145b92915050565b610a19612942565b610a216129a4565b60405163d814eadd60e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063d814eadd90610a7d906035907f0000000000000000000000000000000000000000000000000000000000000000908690600401614247565b60006040518083038186803b158015610a9557600080fd5b505af4158015610aa9573d6000803e3d6000fd5b50505050610ab76001603455565b50565b606060356000018054610acc90614266565b80601f0160208091040260200160405190810160405280929190818152602001828054610af890614266565b8015610b455780601f10610b1a57610100808354040283529160200191610b45565b820191906000526020600020905b815481529060010190602001808311610b2857829003601f168201915b5050505050905090565b6000818152603760205260408120546001600160a01b0316610bcd5760405162461bcd60e51b815260206004820152602c60248201527f4552433732313a20617070726f76656420717565727920666f72206e6f6e657860448201526b34b9ba32b73a103a37b5b2b760a11b60648201526084015b60405180910390fd5b506000908152603d60205260409020546001600160a01b031690565b6000818152603760205260409020546001600160a01b03908116908316819003610c555760405162461bcd60e51b815260206004820152601d60248201527f4552433732313a20617070726f76616c20746f206f6c64206f776e65720000006044820152606401610bc4565b336001600160a01b0382161480610c715750610c7181336108e1565b610ce35760405162461bcd60e51b815260206004820152603860248201527f4552433732313a20617070726f76652063616c6c6572206973206e6f74206f7760448201527f6e6572206e6f7220617070726f76656420666f7220616c6c00000000000000006064820152608401610bc4565b604051631fe5a1d960e11b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d3890633fcb43b290610d1f9060359087908790600401614247565b60006040518083038186803b158015610d3757600080fd5b505af4158015610d4b573d6000803e3d6000fd5b50505050505050565b6040516305da6c1560e11b8152600360048201526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690630bb4d82a90602401602060405180830381865afa158015610dbc573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610de0919061429a565b905090565b6000610def612942565b610df76129a4565b6040516368b8a81d60e11b8152603560048201526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811660248301527f000000000000000000000000000000000000000000000000000000000000000015156044830152606482018690528415156084830152831660a482015273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063d171503a9060c401602060405180830381865af4158015610eb5573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ed991906142b7565b9050610ee56001603455565b9392505050565b610ef46129a4565b610efe33826129fd565b610f1a5760405162461bcd60e51b8152600401610bc4906142d4565b610f25838383612af1565b610f2f6001603455565b505050565b610f3c612afe565b610f446129a4565b60405163a9e15d5560e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063a9e15d5590610f84906035908890889088908890600401614357565b60006040518083038186803b158015610f9c57600080fd5b505af4158015610fb0573d6000803e3d6000fd5b50505050610fbe6001603455565b50505050565b610fcc612942565b610fd46129a4565b6001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001663d346cbd98383600060405190808252806020026020018201604052801561105257816020015b60408051606081018252600080825260208083018290529282015282526000199092019101816110255790505b506040518463ffffffff1660e01b8152600401611071939291906143c0565b600060405180830381600087803b15801561108b57600080fd5b505af115801561109f573d6000803e3d6000fd5b505050506110ad6001603455565b5050565b6000806110bc612942565b6110c46129a4565b60005b848110156112115773869202f90533b8c0f60fcdc225bc60779e6e944863ecd83d2360376110f3612c25565b6040805160e0810182526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811682527f000000000000000000000000000000000000000000000000000000000000000081166020830152604354169181019190915260608101611169600190565b81526020018b8b8881811061118057611180614498565b90506020020135815260200160006001600160a01b031681526020016111a4612c53565b6001600160a01b03168152506040518463ffffffff1660e01b81526004016111ce939291906144ae565b60006040518083038186803b1580156111e657600080fd5b505af41580156111fa573d6000803e3d6000fd5b50505050808061120990614534565b9150506110c7565b5061121f8787878787612cfe565b9150915061122d6001603455565b9550959350505050565b6001600160a01b0382166000908152603c60205260408120546001600160401b031682106112bb5760405162461bcd60e51b815260206004820152602b60248201527f455243373231456e756d657261626c653a206f776e657220696e646578206f7560448201526a74206f6620626f756e647360a81b6064820152608401610bc4565b506001600160a01b03919091166000908152603860209081526040808320938352929052205490565b6112ec612afe565b604080546001600160401b03909216600160a01b0267ffffffffffffffff60a01b19909216919091179055565b611321612942565b604051630d74982760e31b81526001600160a01b03841690636ba4c1389061134f908590859060040161454d565b600060405180830381600087803b15801561136957600080fd5b505af1158015610d4b573d6000803e3d6000fd5b6113856129a4565b610f2583838360405180602001604052806000815250612f24565b600081815260446020526040812054610a0b90612f56565b60408051602081019091526000815260405163dce3f61f60e01b815260009073f5fc7493fed883e3dc2e57bc24981ebbe0560d389063dce3f61f90611426906035907f0000000000000000000000000000000000000000000000000000000000000000908890600401614247565b602060405180830381865af4158015611443573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061146791906142b7565b905080156114905760008381526042602090815260409182902082519182019092529054815291505b50919050565b61149e612afe565b6114a66129a4565b604051635e402e8560e01b8152603560048201526001600160a01b038216602482015273f5fc7493fed883e3dc2e57bc24981ebbe0560d3890635e402e8590604401602060405180830381865af4158015611505573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061152991906142b7565b50610ab76001603455565b61153c612942565b6115446129a4565b6043546001600160a01b031661155d6020830183614561565b65ffffffffffff16156116d25760007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa1580156115ca573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906115ee919061429a565b6040805160018082528183019092529192506000919060208083019080368337019050509050848160008151811061162857611628614498565b602002602001018181525050816001600160a01b031663df03349460018660200160208101906116589190614589565b86858b61166860208c018c614561565b6040518763ffffffff1660e01b8152600401611689969594939291906145ba565b6020604051808303816000875af11580156116a8573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116cc9190614647565b50909450505b604051632142170760e11b81523060048201526001600160a01b038581166024830152604482018590528216906342842e0e90606401600060405180830381600087803b15801561172257600080fd5b505af1158015611736573d6000803e3d6000fd5b5050505050610f2f6001603455565b6000611750603a5490565b82106117b35760405162461bcd60e51b815260206004820152602c60248201527f455243373231456e756d657261626c653a20676c6f62616c20696e646578206f60448201526b7574206f6620626f756e647360a01b6064820152608401610bc4565b603a8054839081106117c7576117c7614498565b90600052602060002001549050919050565b6117e16129a4565b60005b828110156119d05761182384848381811061180157611801614498565b905060200201356000908152603760205260409020546001600160a01b031690565b6001600160a01b0316336001600160a01b03161460405180604001604052806002815260200161393160f01b815250906118705760405162461bcd60e51b8152600401610bc491906136f3565b508115806118b55750600060458186868581811061189057611890614498565b60209081029290920135835250810191909152604001600020546001600160a01b0316145b6040518060400160405280600381526020016231333360e81b815250906118ef5760405162461bcd60e51b8152600401610bc491906136f3565b5073f5fc7493fed883e3dc2e57bc24981ebbe0560d38638062b8dc60357f00000000000000000000000000000000000000000000000000000000000000008888888781811061194057611940614498565b60405160e088901b6001600160e01b031916815260048101969096526001600160a01b03948516602487015292909316604485015260209091020135606483015250841515608482015260a40160006040518083038186803b1580156119a557600080fd5b505af41580156119b9573d6000803e3d6000fd5b5050505080806119c890614534565b9150506117e4565b50610fbe6001603455565b6119e3612afe565b73869202f90533b8c0f60fcdc225bc60779e6e9448634ffde32a611a05612c25565b836040518363ffffffff1660e01b8152600401611a2c929190918252602082015260400190565b60006040518083038186803b158015611a4457600080fd5b505af4158015611a58573d6000803e3d6000fd5b5050505050565b611a67612afe565b6040516395d51ce960e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d38906395d51ce990610d1f90869086908690600401614689565b606060356001018054610acc90614266565b611abc612afe565b604051637529b81960e11b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063ea53703290611b01908b908b908b908b908b908b908b908b906004016146b7565b60006040518083038186803b158015611b1957600080fd5b505af4158015611b2d573d6000803e3d6000fd5b505050505050505050505050565b60408051630c664c6d60e11b8152603560048201523360248201526001600160a01b03841660448201528215156064820152905173f5fc7493fed883e3dc2e57bc24981ebbe0560d38916318cc98da916084808301926000929190829003018186803b158015611baa57600080fd5b505af4158015611bbe573d6000803e3d6000fd5b505050505050565b611bce612942565b611bd66129a4565b604051630464b02960e41b815273869202f90533b8c0f60fcdc225bc60779e6e94489063464b029090611c36907f00000000000000000000000000000000000000000000000000000000000000009060019088908890889060040161471b565b60006040518083038186803b158015611c4e57600080fd5b505af4158015611c62573d6000803e3d6000fd5b50505050610f2f6001603455565b6043546040805163031a9f5160e31b8152603c6004820152603860248201526001600160a01b0392831660448201528383166064820152600160848201527f000000000000000000000000000000000000000000000000000000000000000090921660a48301525160009173869202f90533b8c0f60fcdc225bc60779e6e9448916318d4fa889160c4808201926020929091908290030181865af4158015611d1c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610a0b9190614647565b611d48612afe565b60405163bb30441360e01b81526001600160a01b038085166004830152831660248201526044810182905273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063bb30441390606401610d1f565b60405163dce3f61f60e01b815260009073f5fc7493fed883e3dc2e57bc24981ebbe0560d389063dce3f61f90611df6906035907f0000000000000000000000000000000000000000000000000000000000000000908790600401614247565b602060405180830381865af4158015611e13573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610a0b91906142b7565b611e3f6129a4565b611e4b84848484612f24565b610fbe6001603455565b611e5d612942565b611e656129a4565b604051634e12b69f60e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d3890634e12b69f90610a7d906035907f0000000000000000000000000000000000000000000000000000000000000000908690600401614247565b611ec9612942565b611ed16129a4565b60405163b682e85960e01b81526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000169063b682e85990611f21908690869086906004016147cf565b600060405180830381600087803b158015611f3b57600080fd5b505af1158015611c62573d6000803e3d6000fd5b60435460405163c87b56dd60e01b8152600481018390526060916001600160a01b03169063c87b56dd90602401600060405180830381865afa158015611f99573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610a0b91908101906147fb565b611fc9612afe565b60435460405163b8111a1d60e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389163b8111a1d91612013916001600160a01b0316908890889088908890600401614868565b60006040518083038186803b15801561202b57600080fd5b505af415801561203f573d6000803e3d6000fd5b5050505050505050565b600080612054612942565b61205c6129a4565b604051630f5ec2a360e41b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063f5ec2a30906120e0906035907f0000000000000000000000000000000000000000000000000000000000000000907f0000000000000000000000000000000000000000000000000000000000000000908c908c908c908c906004016148a8565b6040805180830381865af41580156120fc573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061212091906148f5565b9150915061212e6001603455565b94509492505050565b61213f612afe565b60405163a22cb46560e01b81526001600160a01b038381166004830152821515602483015284169063a22cb4659060440161134f565b60015460959060ff16806121885750303b155b80612194575060005481115b6121b05760405162461bcd60e51b8152600401610bc490614919565b60015460ff161580156121cf576001805460ff19168117905560008290555b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663ac7ad9ba6040518163ffffffff1660e01b8152600401602060405180830381865afa15801561222f573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612253919061429a565b604051636eb1769f60e11b81523060048201526001600160a01b037f00000000000000000000000000000000000000000000000000000000000000008116602483015291925060009183169063dd62ed3e90604401602060405180830381865afa1580156122c5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906122e99190614647565b9050806000036123895760405163095ea7b360e01b81526001600160a01b037f000000000000000000000000000000000000000000000000000000000000000081166004830152600019602483015283169063095ea7b3906044016020604051808303816000875af1158015612363573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061238791906142b7565b505b604051636eb1769f60e11b81523060048201526001600160a01b037f00000000000000000000000000000000000000000000000000000000000000008116602483015283169063dd62ed3e90604401602060405180830381865afa1580156123f5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906124199190614647565b9050806000036124b95760405163095ea7b360e01b81526001600160a01b037f000000000000000000000000000000000000000000000000000000000000000081166004830152600019602483015283169063095ea7b3906044016020604051808303816000875af1158015612493573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906124b791906142b7565b505b6124c1610d54565b60405163a22cb46560e01b81526001600160a01b037f00000000000000000000000000000000000000000000000000000000000000008116600483015260016024830152919091169063a22cb46590604401600060405180830381600087803b15801561252d57600080fd5b505af1158015612541573d6000803e3d6000fd5b505050506125568d8d8d8d8d8d8d8d8d612f72565b61255e6131ad565b50508015612571576001805460ff191690555b5050505050505050505050565b6125866129a4565b6000612590612c53565b9050336001600160a01b037f00000000000000000000000000000000000000000000000000000000000000001614806125d15750336001600160a01b038216145b61260e5760405162461bcd60e51b815260206004820152600e60248201526d24b73b30b634b21021b0b63632b960911b6044820152606401610bc4565b73869202f90533b8c0f60fcdc225bc60779e6e944863ecd83d236037612632612c25565b6040805160e0810182526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811682527f0000000000000000000000000000000000000000000000000000000000000000811660208301526043541691810191909152606081016126a8600190565b8152602001888152602001876001600160a01b03168152602001866001600160a01b03168152506040518463ffffffff1660e01b81526004016126ed939291906144ae565b60006040518083038186803b15801561270557600080fd5b505af4158015612719573d6000803e3d6000fd5b50505050506110ad6001603455565b612730612942565b6127386129a4565b60405163aceb362960e01b81526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000169063aceb362990611f21908690869086906004016149ce565b612790612afe565b604080546001600160a01b0319166001600160a01b0392909216919091179055565b6127ba612942565b6127c26129a4565b6040516346583a0560e01b81526001600160a01b037f000000000000000000000000000000000000000000000000000000000000000016906346583a059061107190859085906004016149e2565b63f23a6e6160e01b5b9695505050505050565b61282b612942565b6128336129a4565b610f2583838360006131f9565b612848612942565b6128506129a4565b6001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000166307f5fa4a848460006040519080825280602002602001820160405280156128c857816020015b60408051808201909152600080825260208201528152602001906001900390816128a15790505b50856040518563ffffffff1660e01b8152600401611f219493929190614a0b565b6001600160a01b0381166000908152603c6020526040812060010154610a0b90612f56565b600080612919612942565b6129216129a4565b61292c858585613314565b9150915061293a6001603455565b935093915050565b604080518082019091526002815261323360f01b6020820152337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031614610ab75760405162461bcd60e51b8152600401610bc491906136f3565b6002603454036129f65760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c006044820152606401610bc4565b6002603455565b6000818152603760205260408120546001600160a01b0316612a765760405162461bcd60e51b815260206004820152602c60248201527f4552433732313a206f70657261746f7220717565727920666f72206e6f6e657860448201526b34b9ba32b73a103a37b5b2b760a11b6064820152608401610bc4565b6000828152603760205260409020546001600160a01b03908116908416811480612ac557506001600160a01b038082166000908152603e602090815260408083209388168352929052205460ff165b80612ae95750836001600160a01b0316612ade84610b4f565b6001600160a01b0316145b949350505050565b610f2f83838360016131f9565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663707cd7166040518163ffffffff1660e01b8152600401602060405180830381865afa158015612b5e573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612b82919061429a565b604051637be53ca160e01b81523360048201529091506001600160a01b03821690637be53ca190602401602060405180830381865afa158015612bc9573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612bed91906142b7565b604051806040016040528060018152602001603160f81b815250906110ad5760405162461bcd60e51b8152600401610bc491906136f3565b600080610a0b60017f1a8e31807a80c90bb8226856a878fc772c9f594f08423967b48fec2173694377614ade565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166335ea6a75612c8c610d54565b6040516001600160e01b031960e084901b1681526001600160a01b0390911660048201526024016101c060405180830381865afa158015612cd1573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612cf59190614b64565b60e00151905090565b600080612d0c8786866133c3565b90925090506001600160a01b038616301461122d576043546001600160a01b0316612d3a6020850185614561565b65ffffffffffff1615612e685760007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa158015612da7573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612dcb919061429a565b90506001600160a01b03811663df0334946001612dee6040890160208a01614589565b858b8b8e612dff60208e018e614561565b6040518863ffffffff1660e01b8152600401612e219796959493929190614c75565b6020604051808303816000875af1158015612e40573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612e649190614647565b5096505b60005b85811015612f1857816001600160a01b03166342842e0e308a8a8a86818110612e9657612e96614498565b6040516001600160e01b031960e088901b1681526001600160a01b03958616600482015294909316602485015250602090910201356044820152606401600060405180830381600087803b158015612eed57600080fd5b505af1158015612f01573d6000803e3d6000fd5b505050508080612f1090614534565b915050612e6b565b50509550959350505050565b612f2e33836129fd565b612f4a5760405162461bcd60e51b8152600401610bc4906142d4565b610fbe8484848461346a565b600081600003612f6e57670de0b6b3a7640000610a0b565b5090565b60015460959060ff1680612f855750303b155b80612f91575060005481115b612fad5760405162461bcd60e51b8152600401610bc490614919565b60015460ff16158015612fcc576001805460ff19168117905560008290555b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168b6001600160a01b03161460405180604001604052806002815260200161383760f01b8152509061303a5760405162461bcd60e51b8152600401610bc491906136f3565b5061307a88888080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525061347592505050565b6130b986868080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525061348192505050565b604080518082019091526002815261373760f01b60208201526001600160a01b038b166130f95760405162461bcd60e51b8152600401610bc491906136f3565b50604380546001600160a01b03199081166001600160a01b038d8116918217909355604080549092168c841617825590517f0000000000000000000000000000000000000000000000000000000000000000909216917f9ac15671ebd3c82d023a21bd9f7e73acd088926284381a42cc2e3d31aab9cb3b90613188908d908d908d908d908d908d908d90614cd8565b60405180910390a38015612571576001805460ff191690555050505050505050505050565b60006131b7612c25565b6040516327fef19560e11b815260048101829052601e602482015290915073869202f90533b8c0f60fcdc225bc60779e6e944890634ffde32a90604401611a2c565b73869202f90533b8c0f60fcdc225bc60779e6e944863ecd83d23603761321d612c25565b6040805160e0810182526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811682527f000000000000000000000000000000000000000000000000000000000000000081166020830152604354169181019190915260608101613293600190565b815260208101889052600060408201526060016132ae612c53565b6001600160a01b03168152506040518463ffffffff1660e01b81526004016132d8939291906144ae565b60006040518083038186803b1580156132f057600080fd5b505af4158015613304573d6000803e3d6000fd5b50505050610fbe8484848461348d565b60008073f5fc7493fed883e3dc2e57bc24981ebbe0560d38635238c41460357f00000000000000000000000000000000000000000000000000000000000000008888886040518663ffffffff1660e01b8152600401613377959493929190614d33565b6040805180830381865af4158015613393573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906133b79190614da9565b91509150935093915050565b60008073f5fc7493fed883e3dc2e57bc24981ebbe0560d386346bdd9fe60357f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000000000000000000000000000000008a8a8a6040518863ffffffff1660e01b81526004016133779796959493929190614dd8565b610fbe848484612af1565b60356110ad8282614e6e565b60366110ad8282614e6e565b6043546001600160a01b0316600082156134cd576001600160a01b0386166000908152603c6020526040902054600160401b90046001600160401b031690505b60006134da87878761357f565b90508315610d4b576040516316667cd760e01b81526001600160a01b0384811660048301526024820187905288811660448301528781166064830152821515608483015260a482018490527f000000000000000000000000000000000000000000000000000000000000000016906316667cd79060c401600060405180830381600087803b15801561356b57600080fd5b505af1158015612571573d6000803e3d6000fd5b604051637a420cef60e01b8152603560048201526001600160a01b037f0000000000000000000000000000000000000000000000000000000000000000811660248301527f0000000000000000000000000000000000000000000000000000000000000000151560448301527f0000000000000000000000000000000000000000000000000000000000000000811660648301528085166084830152831660a482015260c4810182905260009073f5fc7493fed883e3dc2e57bc24981ebbe0560d3890637a420cef9060e401602060405180830381865af4158015613668573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612ae991906142b7565b60006020828403121561369e57600080fd5b81356001600160e01b031981168114610ee557600080fd5b6000602082840312156136c857600080fd5b5035919050565b60005b838110156136ea5781810151838201526020016136d2565b50506000910152565b60208152600082518060208401526137128160408501602087016136cf565b601f01601f19169190910160400192915050565b6001600160a01b0381168114610ab757600080fd5b6000806040838503121561374e57600080fd5b823561375981613726565b946020939093013593505050565b634e487b7160e01b600052604160045260246000fd5b6040516101c081016001600160401b03811182821017156137a0576137a0613767565b60405290565b604051601f8201601f191681016001600160401b03811182821017156137ce576137ce613767565b604052919050565b60006001600160401b038211156137ef576137ef613767565b50601f01601f191660200190565b6000806000806080858703121561381357600080fd5b843561381e81613726565b9350602085013561382e81613726565b92506040850135915060608501356001600160401b0381111561385057600080fd5b8501601f8101871361386157600080fd5b803561387461386f826137d6565b6137a6565b81815288602083850101111561388957600080fd5b8160208401602083013760006020838301015280935050505092959194509250565b8015158114610ab757600080fd5b6000806000606084860312156138ce57600080fd5b8335925060208401356138e0816138ab565b915060408401356138f081613726565b809150509250925092565b60008060006060848603121561391057600080fd5b833561391b81613726565b9250602084013561392b81613726565b929592945050506040919091013590565b60008083601f84011261394e57600080fd5b5081356001600160401b0381111561396557600080fd5b6020830191508360208260051b850101111561398057600080fd5b9250929050565b6000806000806040858703121561399d57600080fd5b84356001600160401b03808211156139b457600080fd5b6139c08883890161393c565b909650945060208701359150808211156139d957600080fd5b506139e68782880161393c565b95989497509550505050565b60008060208385031215613a0557600080fd5b82356001600160401b0380821115613a1c57600080fd5b818501915085601f830112613a3057600080fd5b813581811115613a3f57600080fd5b866020606083028501011115613a5457600080fd5b60209290920196919550909350505050565b60006040828403121561149057600080fd5b600080600080600060a08688031215613a9057600080fd5b8535613a9b81613726565b94506020860135613aab81613726565b935060408601356001600160401b03811115613ac657600080fd5b613ad28882890161393c565b9094509250613ae690508760608801613a66565b90509295509295909350565b6001600160401b0381168114610ab757600080fd5b600060208284031215613b1957600080fd5b8135610ee581613af2565b600080600060408486031215613b3957600080fd5b8335613b4481613726565b925060208401356001600160401b03811115613b5f57600080fd5b613b6b8682870161393c565b9497909650939450505050565b600060208284031215613b8a57600080fd5b8135610ee581613726565b600080600060808486031215613baa57600080fd5b8335613bb581613726565b925060208401359150613bcb8560408601613a66565b90509250925092565b60008060008060608587031215613bea57600080fd5b8435613bf581613726565b935060208501356001600160401b03811115613c1057600080fd5b613c1c8782880161393c565b9094509250506040850135613c30816138ab565b939692955090935050565b60008083601f840112613c4d57600080fd5b5081356001600160401b03811115613c6457600080fd5b60208301915083602082850101111561398057600080fd5b600080600060408486031215613c9157600080fd5b8335613c9c81613726565b925060208401356001600160401b03811115613cb757600080fd5b613b6b86828701613c3b565b60008060008060008060008060a0898b031215613cdf57600080fd5b8835613cea81613726565b97506020890135613cfa81613726565b965060408901356001600160401b0380821115613d1657600080fd5b613d228c838d0161393c565b909850965060608b0135915080821115613d3b57600080fd5b613d478c838d0161393c565b909650945060808b0135915080821115613d6057600080fd5b50613d6d8b828c01613c3b565b999c989b5096995094979396929594505050565b60008060408385031215613d9457600080fd5b8235613d9f81613726565b91506020830135613daf816138ab565b809150509250929050565b600080600060408486031215613dcf57600080fd5b83356001600160401b0380821115613de657600080fd5b818601915086601f830112613dfa57600080fd5b813581811115613e0957600080fd5b8760208260071b8501011115613e1e57600080fd5b602092830195509350508401356138f081613726565b634e487b7160e01b600052602160045260246000fd5b60208101601d8310613e5e57613e5e613e34565b91905290565b600080600060408486031215613e7957600080fd5b83356001600160401b03811115613e8f57600080fd5b613e9b8682870161393c565b90945092505060208401356138f081613726565b60008060008060608587031215613ec557600080fd5b8435613ed081613726565b93506020850135613ee081613726565b925060408501356001600160401b03811115613efb57600080fd5b6139e68782880161393c565b60008060008060608587031215613f1d57600080fd5b84356001600160401b03811115613f3357600080fd5b613f3f8782880161393c565b9095509350506020850135613f53816138ab565b91506040850135613c3081613726565b600080600060608486031215613f7857600080fd5b8335613f8381613726565b92506020840135613f9381613726565b915060408401356138f0816138ab565b600080600080600080600080600060c08a8c031215613fc157600080fd5b8935613fcc81613726565b985060208a0135613fdc81613726565b975060408a0135613fec81613726565b965060608a01356001600160401b038082111561400857600080fd5b6140148d838e01613c3b565b909850965060808c013591508082111561402d57600080fd5b6140398d838e01613c3b565b909650945060a08c013591508082111561405257600080fd5b5061405f8c828d01613c3b565b915080935050809150509295985092959850929598565b6000806040838503121561408957600080fd5b823591506020830135613daf81613726565b60008083601f8401126140ad57600080fd5b5081356001600160401b038111156140c457600080fd5b6020830191508360208260061b850101111561398057600080fd5b6000806000604084860312156140f457600080fd5b83356001600160401b0381111561410a57600080fd5b613e9b8682870161409b565b6000806040838503121561412957600080fd5b823561413481613726565b91506020830135613daf81613726565b6000806020838503121561415757600080fd5b82356001600160401b0381111561416d57600080fd5b6141798582860161409b565b90969095509350505050565b60008060008060008060a0878903121561419e57600080fd5b86356141a981613726565b955060208701356141b981613726565b9450604087013593506060870135925060808701356001600160401b038111156141e257600080fd5b6141ee89828a01613c3b565b979a9699509497509295939492505050565b60008060006040848603121561421557600080fd5b833561422081613726565b925060208401356001600160401b0381111561423b57600080fd5b613b6b8682870161409b565b9283526001600160a01b03919091166020830152604082015260600190565b600181811c9082168061427a57607f821691505b60208210810361149057634e487b7160e01b600052602260045260246000fd5b6000602082840312156142ac57600080fd5b8151610ee581613726565b6000602082840312156142c957600080fd5b8151610ee5816138ab565b60208082526031908201527f4552433732313a207472616e736665722063616c6c6572206973206e6f74206f6040820152701ddb995c881b9bdc88185c1c1c9bdd9959607a1b606082015260800190565b81835260006001600160fb1b0383111561433e57600080fd5b8260051b80836020870137939093016020019392505050565b858152606060208201526000614371606083018688614325565b8281036040840152614384818587614325565b98975050505050505050565b803563ffffffff811681146143a457600080fd5b919050565b80356001600160b81b03811681146143a457600080fd5b6040808252818101849052600090606080840187845b8881101561442c5763ffffffff806143ed84614390565b1684526020816143fe828601614390565b1690850152506001600160b81b036144178387016143a9565b168386015291830191908301906001016143d6565b505084810360208681019190915286518083528782019282019060005b81811015614488578451805163ffffffff90811685528582015116858501528701516001600160b81b0316878401529383019391850191600101614449565b50909a9950505050505050505050565b634e487b7160e01b600052603260045260246000fd5b60006101208201905084825283602083015260018060a01b03808451166040840152806020850151166060840152806040850151166080840152606084015160a0840152608084015160c08401528060a08501511660e08401528060c08501511661010084015250949350505050565b634e487b7160e01b600052601160045260246000fd5b6000600182016145465761454661451e565b5060010190565b602081526000612ae9602083018486614325565b60006020828403121561457357600080fd5b813565ffffffffffff81168114610ee557600080fd5b60006020828403121561459b57600080fd5b813560028110610ee557600080fd5b60028110610ab757610ab7613e34565b600060c082016145c9896145aa565b88835260206145d7896145aa565b8381018990526001600160a01b03888116604086015260c060608601528751928390528782019260e086019060005b8181101561462257855183529484019491840191600101614606565b50509616608085015250505065ffffffffffff9190911660a090910152949350505050565b60006020828403121561465957600080fd5b5051919050565b81835281816020850137506000828201602090810191909152601f909101601f19169091010190565b6001600160a01b03841681526040602082018190526000906146ae9083018486614660565b95945050505050565b6001600160a01b0389811682528816602082015260a0604082018190526000906146e4908301888a614325565b82810360608401526146f7818789614325565b9050828103608084015261470c818587614660565b9b9a5050505050505050505050565b6001600160a01b0386168152602080820186905260806040808401829052838201869052600092879160a08601855b898110156147b35763ffffffff8061476187614390565b16835280614770868801614390565b1683860152506001600160b81b036147898685016143a9565b168383015260608086013561479d816138ab565b151590830152938501939085019060010161474a565b506001600160a01b038816606088015294506128199350505050565b6040815260006147e3604083018587614325565b905060018060a01b0383166020830152949350505050565b60006020828403121561480d57600080fd5b81516001600160401b0381111561482357600080fd5b8201601f8101841361483457600080fd5b805161484261386f826137d6565b81815285602083850101111561485757600080fd5b6146ae8260208301602086016136cf565b6001600160a01b03868116825285811660208301528416604082015260806060820181905260009061489d9083018486614325565b979650505050505050565b878152600060018060a01b038089166020840152871515604084015260c060608401526148d960c084018789614325565b94151560808401529290921660a0909101525095945050505050565b6000806040838503121561490857600080fd5b505080516020909101519092909150565b6020808252602e908201527f436f6e747261637420696e7374616e63652068617320616c726561647920626560408201526d195b881a5b9a5d1a585b1a5e995960921b606082015260800190565b818352600060208085019450826000805b868110156149c25763ffffffff61498e84614390565b168852828401356001600160e01b0381168082146149aa578384fd5b89860152506040978801979290920191600101614978565b50959695505050505050565b6040815260006147e3604083018587614967565b602081526000612ae9602083018486614967565b6001600160801b0381168114610ab757600080fd5b6060808252810184905260008560808301825b87811015614a65578235614a31816149f6565b6001600160801b03908116835260209084820135614a4e816149f6565b169083015260409283019290910190600101614a1e565b5060209150838103828501528086518083528383019150838801925060005b81811015614ab857835180516001600160801b03908116855290860151168584015292840192604090920191600101614a84565b50506001600160a01b038616604086015292506146ae915050565b80516143a481613726565b81810381811115610a0b57610a0b61451e565b600060208284031215614b0357600080fd5b604051602081018181106001600160401b0382111715614b2557614b25613767565b6040529151825250919050565b80516143a4816149f6565b805164ffffffffff811681146143a457600080fd5b805161ffff811681146143a457600080fd5b60006101c08284031215614b7757600080fd5b614b7f61377d565b614b898484614af1565b8152614b9760208401614b32565b6020820152614ba860408401614b32565b6040820152614bb960608401614b32565b6060820152614bca60808401614b32565b6080820152614bdb60a08401614b3d565b60a0820152614bec60c08401614b52565b60c0820152614bfd60e08401614ad3565b60e0820152610100614c10818501614ad3565b90820152610120614c22848201614ad3565b90820152610140614c34848201614ad3565b90820152610160614c46848201614b32565b90820152610180614c58848201614ad3565b908201526101a0614c6a848201614b32565b908201529392505050565b614c7e886145aa565b878152614c8a876145aa565b866020820152600060018060a01b03808816604084015260c06060840152614cb660c084018789614325565b941660808301525065ffffffffffff9190911660a09091015295945050505050565b6001600160a01b0388168152608060208201819052600090614cfd908301888a614660565b8281036040840152614d10818789614660565b90508281036060840152614d25818587614660565b9a9950505050505050505050565b600060808201878352602087151581850152604060018060a01b03881681860152608060608601528286845260a08601905087935060005b87811015614d9a578435825283850135614d84816138ab565b1515828501529382019390820190600101614d6b565b509a9950505050505050505050565b60008060408385031215614dbc57600080fd5b8251614dc781613af2565b6020840151909250613daf81613af2565b8781526001600160a01b038781166020830152861515604083015285811660608301528416608082015260c060a08201819052600090614e1b9083018486614325565b9998505050505050505050565b601f821115610f2f57600081815260208120601f850160051c81016020861015614e4f5750805b601f850160051c820191505b81811015611bbe57828155600101614e5b565b81516001600160401b03811115614e8757614e87613767565b614e9b81614e958454614266565b84614e28565b602080601f831160018114614ed05760008415614eb85750858301515b600019600386901b1c1916600185901b178555611bbe565b600085815260208120601f198616915b82811015614eff57888601518255948401946001909101908401614ee0565b5085821015614f1d5787850151600019600388901b60f8161c191681555b5050505050600190811b0190555056fea2646970667358221220cfcff4a86a1551dd58ad635f4f0878d3e3826044694a52c2a37f30fcfb82208764736f6c634300081100330000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb900000000000000000000000000000000000076a84fef008cdabe6409d2fe638b
Deployed Bytecode
0x608060405234801561001057600080fd5b50600436106103ba5760003560e01c80639420d32d116101f4578063c87b56dd1161011a578063e985e9c5116100ad578063f866c3191161007c578063f866c31914610958578063f9b95b431461096b578063fac2c0081461097e578063ff5effc01461099157600080fd5b8063e985e9c5146108d3578063eda2438c1461090f578063f23a6e6114610922578063f3fdfcd71461093557600080fd5b8063d7768ba7116100e9578063d7768ba714610887578063de41f1a91461089a578063e4596b3c146108ad578063e655dbd8146108c057600080fd5b8063c87b56dd14610826578063ccb4dd6114610839578063d0db1e231461084c578063d343852c1461087457600080fd5b8063a6fc2e8d11610192578063b88d4fde11610161578063b88d4fde146107cb578063b9a2de3a146107de578063bc197c81146107f1578063c716d80e1461081357600080fd5b8063a6fc2e8d14610781578063b16a19de14610794578063b2118a8d146107a5578063b5cb00ec146107b857600080fd5b80639ff903cd116101ce5780639ff903cd14610739578063a22cb4651461074c578063a54c6c4d1461075f578063a6627c8b1461077257600080fd5b80639420d32d1461070b57806395d51ce91461071e57806395d89b411461073157600080fd5b8063336d5e46116102e457806350ac06871161027757806375d264131161024657806375d26413146106b957806379c6cb3f146106ca5780638286eee2146106d25780638760f5e4146106f857600080fd5b806350ac0687146105ff57806360d6374e146106255780636352211e1461065e57806370a082311461068757600080fd5b806344f27e30116102b357806344f27e30146105a457806345f61e76146105c65780634f2c268f146105d95780634f6ccce7146105ec57600080fd5b8063336d5e46146105585780633421772f1461056b57806342842e0e1461057e57806343f8ac891461059157600080fd5b80631a6ed5ec1161035c5780632a933cc41161032b5780632a933cc4146104d95780632af5d473146104ec5780632f745c591461051f578063330b70241461053257600080fd5b80631a6ed5ec146104985780631e79a8c0146104a057806323b872dd146104b357806326b495a7146104c657600080fd5b8063081812fc11610398578063081812fc14610411578063095ea7b31461043c578063150b7a021461044f57806318160ddd1461048657600080fd5b806301ffc9a7146103bf578063065de74c146103e757806306fdde03146103fc575b600080fd5b6103d26103cd36600461368c565b6109a4565b60405190151581526020015b60405180910390f35b6103fa6103f53660046136b6565b610a11565b005b610404610aba565b6040516103de91906136f3565b61042461041f3660046136b6565b610b4f565b6040516001600160a01b0390911681526020016103de565b6103fa61044a36600461373b565b610be9565b61046d61045d3660046137fd565b630a85bd0160e11b949350505050565b6040516001600160e01b031990911681526020016103de565b603a545b6040519081526020016103de565b610424610d54565b6103d26104ae3660046138b9565b610de5565b6103fa6104c13660046138fb565b610eec565b6103fa6104d4366004613987565b610f34565b6103fa6104e73660046139f2565b610fc4565b6104ff6104fa366004613a78565b6110b1565b604080516001600160401b039384168152929091166020830152016103de565b61048a61052d36600461373b565b611237565b7f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb9610424565b6103fa610566366004613b07565b6112e4565b6103fa610579366004613b24565b611319565b6103fa61058c3660046138fb565b61137d565b61048a61059f3660046136b6565b6113a0565b6105b76105b23660046136b6565b6113b8565b604051905181526020016103de565b6103fa6105d4366004613b78565b611496565b6103fa6105e7366004613b95565b611534565b61048a6105fa3660046136b6565b611745565b7f00000000000000000000000000000000000000000000000000000000000000006103d2565b61048a610633366004613b78565b6001600160a01b03166000908152603c6020526040902054600160401b90046001600160401b031690565b61042461066c3660046136b6565b6000908152603760205260409020546001600160a01b031690565b61048a610695366004613b78565b6001600160a01b03166000908152603c60205260409020546001600160401b031690565b6040546001600160a01b0316610424565b61048a609581565b7f00000000000000000000000000000000000076a84fef008cdabe6409d2fe638b610424565b6103fa610706366004613bd4565b6117d9565b6103fa6107193660046136b6565b6119db565b6103fa61072c366004613c7c565b611a5f565b610404611aa2565b6103fa610747366004613cc3565b611ab4565b6103fa61075a366004613d81565b611b3b565b6103fa61076d366004613dba565b611bc6565b60046040516103de9190613e4a565b61048a61078f366004613b78565b611c70565b6043546001600160a01b0316610424565b6103fa6107b33660046138fb565b611d40565b6103d26107c63660046136b6565b611d97565b6103fa6107d93660046137fd565b611e37565b6103fa6107ec3660046136b6565b611e55565b61046d6107ff366004613cc3565b63bc197c8160e01b98975050505050505050565b6103fa610821366004613e64565b611ec1565b6104046108343660046136b6565b611f4f565b6103fa610847366004613eaf565b611fc1565b61085f61085a366004613f07565b612049565b604080519283526020830191909152016103de565b6103fa610882366004613f63565b612137565b6103fa610895366004613fa3565b612175565b6103fa6108a8366004614076565b61257e565b6103fa6108bb3660046140df565b612728565b6103fa6108ce366004613b78565b612788565b6103d26108e1366004614116565b6001600160a01b039182166000908152603e6020908152604080832093909416825291909152205460ff1690565b6103fa61091d366004614144565b6127b2565b61046d610930366004614185565b612810565b6103d26109433660046136b6565b60009081526041602052604090205460ff1690565b6103fa6109663660046138fb565b612823565b6103fa6109793660046140df565b612840565b61048a61098c366004613b78565b6128e9565b6104ff61099f366004614200565b61290e565b60006001600160e01b031982166380ac58cd60e01b14806109d557506001600160e01b0319821663780e9d6360e01b145b806109f057506001600160e01b03198216635b5e139f60e01b145b80610a0b57506001600160e01b031982166301ffc9a760e01b145b92915050565b610a19612942565b610a216129a4565b60405163d814eadd60e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063d814eadd90610a7d906035907f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff908690600401614247565b60006040518083038186803b158015610a9557600080fd5b505af4158015610aa9573d6000803e3d6000fd5b50505050610ab76001603455565b50565b606060356000018054610acc90614266565b80601f0160208091040260200160405190810160405280929190818152602001828054610af890614266565b8015610b455780601f10610b1a57610100808354040283529160200191610b45565b820191906000526020600020905b815481529060010190602001808311610b2857829003601f168201915b5050505050905090565b6000818152603760205260408120546001600160a01b0316610bcd5760405162461bcd60e51b815260206004820152602c60248201527f4552433732313a20617070726f76656420717565727920666f72206e6f6e657860448201526b34b9ba32b73a103a37b5b2b760a11b60648201526084015b60405180910390fd5b506000908152603d60205260409020546001600160a01b031690565b6000818152603760205260409020546001600160a01b03908116908316819003610c555760405162461bcd60e51b815260206004820152601d60248201527f4552433732313a20617070726f76616c20746f206f6c64206f776e65720000006044820152606401610bc4565b336001600160a01b0382161480610c715750610c7181336108e1565b610ce35760405162461bcd60e51b815260206004820152603860248201527f4552433732313a20617070726f76652063616c6c6572206973206e6f74206f7760448201527f6e6572206e6f7220617070726f76656420666f7220616c6c00000000000000006064820152608401610bc4565b604051631fe5a1d960e11b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d3890633fcb43b290610d1f9060359087908790600401614247565b60006040518083038186803b158015610d3757600080fd5b505af4158015610d4b573d6000803e3d6000fd5b50505050505050565b6040516305da6c1560e11b8152600360048201526000907f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb96001600160a01b031690630bb4d82a90602401602060405180830381865afa158015610dbc573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610de0919061429a565b905090565b6000610def612942565b610df76129a4565b6040516368b8a81d60e11b8152603560048201526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff811660248301527f000000000000000000000000000000000000000000000000000000000000000015156044830152606482018690528415156084830152831660a482015273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063d171503a9060c401602060405180830381865af4158015610eb5573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ed991906142b7565b9050610ee56001603455565b9392505050565b610ef46129a4565b610efe33826129fd565b610f1a5760405162461bcd60e51b8152600401610bc4906142d4565b610f25838383612af1565b610f2f6001603455565b505050565b610f3c612afe565b610f446129a4565b60405163a9e15d5560e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063a9e15d5590610f84906035908890889088908890600401614357565b60006040518083038186803b158015610f9c57600080fd5b505af4158015610fb0573d6000803e3d6000fd5b50505050610fbe6001603455565b50505050565b610fcc612942565b610fd46129a4565b6001600160a01b037f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb91663d346cbd98383600060405190808252806020026020018201604052801561105257816020015b60408051606081018252600080825260208083018290529282015282526000199092019101816110255790505b506040518463ffffffff1660e01b8152600401611071939291906143c0565b600060405180830381600087803b15801561108b57600080fd5b505af115801561109f573d6000803e3d6000fd5b505050506110ad6001603455565b5050565b6000806110bc612942565b6110c46129a4565b60005b848110156112115773869202f90533b8c0f60fcdc225bc60779e6e944863ecd83d2360376110f3612c25565b6040805160e0810182526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff811682527f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb981166020830152604354169181019190915260608101611169600190565b81526020018b8b8881811061118057611180614498565b90506020020135815260200160006001600160a01b031681526020016111a4612c53565b6001600160a01b03168152506040518463ffffffff1660e01b81526004016111ce939291906144ae565b60006040518083038186803b1580156111e657600080fd5b505af41580156111fa573d6000803e3d6000fd5b50505050808061120990614534565b9150506110c7565b5061121f8787878787612cfe565b9150915061122d6001603455565b9550959350505050565b6001600160a01b0382166000908152603c60205260408120546001600160401b031682106112bb5760405162461bcd60e51b815260206004820152602b60248201527f455243373231456e756d657261626c653a206f776e657220696e646578206f7560448201526a74206f6620626f756e647360a81b6064820152608401610bc4565b506001600160a01b03919091166000908152603860209081526040808320938352929052205490565b6112ec612afe565b604080546001600160401b03909216600160a01b0267ffffffffffffffff60a01b19909216919091179055565b611321612942565b604051630d74982760e31b81526001600160a01b03841690636ba4c1389061134f908590859060040161454d565b600060405180830381600087803b15801561136957600080fd5b505af1158015610d4b573d6000803e3d6000fd5b6113856129a4565b610f2583838360405180602001604052806000815250612f24565b600081815260446020526040812054610a0b90612f56565b60408051602081019091526000815260405163dce3f61f60e01b815260009073f5fc7493fed883e3dc2e57bc24981ebbe0560d389063dce3f61f90611426906035907f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff908890600401614247565b602060405180830381865af4158015611443573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061146791906142b7565b905080156114905760008381526042602090815260409182902082519182019092529054815291505b50919050565b61149e612afe565b6114a66129a4565b604051635e402e8560e01b8152603560048201526001600160a01b038216602482015273f5fc7493fed883e3dc2e57bc24981ebbe0560d3890635e402e8590604401602060405180830381865af4158015611505573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061152991906142b7565b50610ab76001603455565b61153c612942565b6115446129a4565b6043546001600160a01b031661155d6020830183614561565b65ffffffffffff16156116d25760007f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa1580156115ca573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906115ee919061429a565b6040805160018082528183019092529192506000919060208083019080368337019050509050848160008151811061162857611628614498565b602002602001018181525050816001600160a01b031663df03349460018660200160208101906116589190614589565b86858b61166860208c018c614561565b6040518763ffffffff1660e01b8152600401611689969594939291906145ba565b6020604051808303816000875af11580156116a8573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116cc9190614647565b50909450505b604051632142170760e11b81523060048201526001600160a01b038581166024830152604482018590528216906342842e0e90606401600060405180830381600087803b15801561172257600080fd5b505af1158015611736573d6000803e3d6000fd5b5050505050610f2f6001603455565b6000611750603a5490565b82106117b35760405162461bcd60e51b815260206004820152602c60248201527f455243373231456e756d657261626c653a20676c6f62616c20696e646578206f60448201526b7574206f6620626f756e647360a01b6064820152608401610bc4565b603a8054839081106117c7576117c7614498565b90600052602060002001549050919050565b6117e16129a4565b60005b828110156119d05761182384848381811061180157611801614498565b905060200201356000908152603760205260409020546001600160a01b031690565b6001600160a01b0316336001600160a01b03161460405180604001604052806002815260200161393160f01b815250906118705760405162461bcd60e51b8152600401610bc491906136f3565b508115806118b55750600060458186868581811061189057611890614498565b60209081029290920135835250810191909152604001600020546001600160a01b0316145b6040518060400160405280600381526020016231333360e81b815250906118ef5760405162461bcd60e51b8152600401610bc491906136f3565b5073f5fc7493fed883e3dc2e57bc24981ebbe0560d38638062b8dc60357f00000000000000000000000000000000000076a84fef008cdabe6409d2fe638b8888888781811061194057611940614498565b60405160e088901b6001600160e01b031916815260048101969096526001600160a01b03948516602487015292909316604485015260209091020135606483015250841515608482015260a40160006040518083038186803b1580156119a557600080fd5b505af41580156119b9573d6000803e3d6000fd5b5050505080806119c890614534565b9150506117e4565b50610fbe6001603455565b6119e3612afe565b73869202f90533b8c0f60fcdc225bc60779e6e9448634ffde32a611a05612c25565b836040518363ffffffff1660e01b8152600401611a2c929190918252602082015260400190565b60006040518083038186803b158015611a4457600080fd5b505af4158015611a58573d6000803e3d6000fd5b5050505050565b611a67612afe565b6040516395d51ce960e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d38906395d51ce990610d1f90869086908690600401614689565b606060356001018054610acc90614266565b611abc612afe565b604051637529b81960e11b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063ea53703290611b01908b908b908b908b908b908b908b908b906004016146b7565b60006040518083038186803b158015611b1957600080fd5b505af4158015611b2d573d6000803e3d6000fd5b505050505050505050505050565b60408051630c664c6d60e11b8152603560048201523360248201526001600160a01b03841660448201528215156064820152905173f5fc7493fed883e3dc2e57bc24981ebbe0560d38916318cc98da916084808301926000929190829003018186803b158015611baa57600080fd5b505af4158015611bbe573d6000803e3d6000fd5b505050505050565b611bce612942565b611bd66129a4565b604051630464b02960e41b815273869202f90533b8c0f60fcdc225bc60779e6e94489063464b029090611c36907f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb99060019088908890889060040161471b565b60006040518083038186803b158015611c4e57600080fd5b505af4158015611c62573d6000803e3d6000fd5b50505050610f2f6001603455565b6043546040805163031a9f5160e31b8152603c6004820152603860248201526001600160a01b0392831660448201528383166064820152600160848201527f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb990921660a48301525160009173869202f90533b8c0f60fcdc225bc60779e6e9448916318d4fa889160c4808201926020929091908290030181865af4158015611d1c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610a0b9190614647565b611d48612afe565b60405163bb30441360e01b81526001600160a01b038085166004830152831660248201526044810182905273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063bb30441390606401610d1f565b60405163dce3f61f60e01b815260009073f5fc7493fed883e3dc2e57bc24981ebbe0560d389063dce3f61f90611df6906035907f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff908790600401614247565b602060405180830381865af4158015611e13573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610a0b91906142b7565b611e3f6129a4565b611e4b84848484612f24565b610fbe6001603455565b611e5d612942565b611e656129a4565b604051634e12b69f60e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d3890634e12b69f90610a7d906035907f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff908690600401614247565b611ec9612942565b611ed16129a4565b60405163b682e85960e01b81526001600160a01b037f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb9169063b682e85990611f21908690869086906004016147cf565b600060405180830381600087803b158015611f3b57600080fd5b505af1158015611c62573d6000803e3d6000fd5b60435460405163c87b56dd60e01b8152600481018390526060916001600160a01b03169063c87b56dd90602401600060405180830381865afa158015611f99573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610a0b91908101906147fb565b611fc9612afe565b60435460405163b8111a1d60e01b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389163b8111a1d91612013916001600160a01b0316908890889088908890600401614868565b60006040518083038186803b15801561202b57600080fd5b505af415801561203f573d6000803e3d6000fd5b5050505050505050565b600080612054612942565b61205c6129a4565b604051630f5ec2a360e41b815273f5fc7493fed883e3dc2e57bc24981ebbe0560d389063f5ec2a30906120e0906035907f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff907f0000000000000000000000000000000000000000000000000000000000000000908c908c908c908c906004016148a8565b6040805180830381865af41580156120fc573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061212091906148f5565b9150915061212e6001603455565b94509492505050565b61213f612afe565b60405163a22cb46560e01b81526001600160a01b038381166004830152821515602483015284169063a22cb4659060440161134f565b60015460959060ff16806121885750303b155b80612194575060005481115b6121b05760405162461bcd60e51b8152600401610bc490614919565b60015460ff161580156121cf576001805460ff19168117905560008290555b60007f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb96001600160a01b031663ac7ad9ba6040518163ffffffff1660e01b8152600401602060405180830381865afa15801561222f573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612253919061429a565b604051636eb1769f60e11b81523060048201526001600160a01b037f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb98116602483015291925060009183169063dd62ed3e90604401602060405180830381865afa1580156122c5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906122e99190614647565b9050806000036123895760405163095ea7b360e01b81526001600160a01b037f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb981166004830152600019602483015283169063095ea7b3906044016020604051808303816000875af1158015612363573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061238791906142b7565b505b604051636eb1769f60e11b81523060048201526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff8116602483015283169063dd62ed3e90604401602060405180830381865afa1580156123f5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906124199190614647565b9050806000036124b95760405163095ea7b360e01b81526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff81166004830152600019602483015283169063095ea7b3906044016020604051808303816000875af1158015612493573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906124b791906142b7565b505b6124c1610d54565b60405163a22cb46560e01b81526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff8116600483015260016024830152919091169063a22cb46590604401600060405180830381600087803b15801561252d57600080fd5b505af1158015612541573d6000803e3d6000fd5b505050506125568d8d8d8d8d8d8d8d8d612f72565b61255e6131ad565b50508015612571576001805460ff191690555b5050505050505050505050565b6125866129a4565b6000612590612c53565b9050336001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff1614806125d15750336001600160a01b038216145b61260e5760405162461bcd60e51b815260206004820152600e60248201526d24b73b30b634b21021b0b63632b960911b6044820152606401610bc4565b73869202f90533b8c0f60fcdc225bc60779e6e944863ecd83d236037612632612c25565b6040805160e0810182526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff811682527f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb9811660208301526043541691810191909152606081016126a8600190565b8152602001888152602001876001600160a01b03168152602001866001600160a01b03168152506040518463ffffffff1660e01b81526004016126ed939291906144ae565b60006040518083038186803b15801561270557600080fd5b505af4158015612719573d6000803e3d6000fd5b50505050506110ad6001603455565b612730612942565b6127386129a4565b60405163aceb362960e01b81526001600160a01b037f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb9169063aceb362990611f21908690869086906004016149ce565b612790612afe565b604080546001600160a01b0319166001600160a01b0392909216919091179055565b6127ba612942565b6127c26129a4565b6040516346583a0560e01b81526001600160a01b037f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb916906346583a059061107190859085906004016149e2565b63f23a6e6160e01b5b9695505050505050565b61282b612942565b6128336129a4565b610f2583838360006131f9565b612848612942565b6128506129a4565b6001600160a01b037f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb9166307f5fa4a848460006040519080825280602002602001820160405280156128c857816020015b60408051808201909152600080825260208201528152602001906001900390816128a15790505b50856040518563ffffffff1660e01b8152600401611f219493929190614a0b565b6001600160a01b0381166000908152603c6020526040812060010154610a0b90612f56565b600080612919612942565b6129216129a4565b61292c858585613314565b9150915061293a6001603455565b935093915050565b604080518082019091526002815261323360f01b6020820152337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031614610ab75760405162461bcd60e51b8152600401610bc491906136f3565b6002603454036129f65760405162461bcd60e51b815260206004820152601f60248201527f5265656e7472616e637947756172643a207265656e7472616e742063616c6c006044820152606401610bc4565b6002603455565b6000818152603760205260408120546001600160a01b0316612a765760405162461bcd60e51b815260206004820152602c60248201527f4552433732313a206f70657261746f7220717565727920666f72206e6f6e657860448201526b34b9ba32b73a103a37b5b2b760a11b6064820152608401610bc4565b6000828152603760205260409020546001600160a01b03908116908416811480612ac557506001600160a01b038082166000908152603e602090815260408083209388168352929052205460ff165b80612ae95750836001600160a01b0316612ade84610b4f565b6001600160a01b0316145b949350505050565b610f2f83838360016131f9565b60007f000000000000000000000000fae470a311f61944346bbb8709cdc2398506be466001600160a01b031663707cd7166040518163ffffffff1660e01b8152600401602060405180830381865afa158015612b5e573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612b82919061429a565b604051637be53ca160e01b81523360048201529091506001600160a01b03821690637be53ca190602401602060405180830381865afa158015612bc9573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612bed91906142b7565b604051806040016040528060018152602001603160f81b815250906110ad5760405162461bcd60e51b8152600401610bc491906136f3565b600080610a0b60017f1a8e31807a80c90bb8226856a878fc772c9f594f08423967b48fec2173694377614ade565b60007f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b03166335ea6a75612c8c610d54565b6040516001600160e01b031960e084901b1681526001600160a01b0390911660048201526024016101c060405180830381865afa158015612cd1573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612cf59190614b64565b60e00151905090565b600080612d0c8786866133c3565b90925090506001600160a01b038616301461122d576043546001600160a01b0316612d3a6020850185614561565b65ffffffffffff1615612e685760007f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa158015612da7573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612dcb919061429a565b90506001600160a01b03811663df0334946001612dee6040890160208a01614589565b858b8b8e612dff60208e018e614561565b6040518863ffffffff1660e01b8152600401612e219796959493929190614c75565b6020604051808303816000875af1158015612e40573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612e649190614647565b5096505b60005b85811015612f1857816001600160a01b03166342842e0e308a8a8a86818110612e9657612e96614498565b6040516001600160e01b031960e088901b1681526001600160a01b03958616600482015294909316602485015250602090910201356044820152606401600060405180830381600087803b158015612eed57600080fd5b505af1158015612f01573d6000803e3d6000fd5b505050508080612f1090614534565b915050612e6b565b50509550959350505050565b612f2e33836129fd565b612f4a5760405162461bcd60e51b8152600401610bc4906142d4565b610fbe8484848461346a565b600081600003612f6e57670de0b6b3a7640000610a0b565b5090565b60015460959060ff1680612f855750303b155b80612f91575060005481115b612fad5760405162461bcd60e51b8152600401610bc490614919565b60015460ff16158015612fcc576001805460ff19168117905560008290555b7f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b03168b6001600160a01b03161460405180604001604052806002815260200161383760f01b8152509061303a5760405162461bcd60e51b8152600401610bc491906136f3565b5061307a88888080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525061347592505050565b6130b986868080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525061348192505050565b604080518082019091526002815261373760f01b60208201526001600160a01b038b166130f95760405162461bcd60e51b8152600401610bc491906136f3565b50604380546001600160a01b03199081166001600160a01b038d8116918217909355604080549092168c841617825590517f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff909216917f9ac15671ebd3c82d023a21bd9f7e73acd088926284381a42cc2e3d31aab9cb3b90613188908d908d908d908d908d908d908d90614cd8565b60405180910390a38015612571576001805460ff191690555050505050505050505050565b60006131b7612c25565b6040516327fef19560e11b815260048101829052601e602482015290915073869202f90533b8c0f60fcdc225bc60779e6e944890634ffde32a90604401611a2c565b73869202f90533b8c0f60fcdc225bc60779e6e944863ecd83d23603761321d612c25565b6040805160e0810182526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff811682527f0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb981166020830152604354169181019190915260608101613293600190565b815260208101889052600060408201526060016132ae612c53565b6001600160a01b03168152506040518463ffffffff1660e01b81526004016132d8939291906144ae565b60006040518083038186803b1580156132f057600080fd5b505af4158015613304573d6000803e3d6000fd5b50505050610fbe8484848461348d565b60008073f5fc7493fed883e3dc2e57bc24981ebbe0560d38635238c41460357f00000000000000000000000000000000000000000000000000000000000000008888886040518663ffffffff1660e01b8152600401613377959493929190614d33565b6040805180830381865af4158015613393573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906133b79190614da9565b91509150935093915050565b60008073f5fc7493fed883e3dc2e57bc24981ebbe0560d386346bdd9fe60357f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff7f00000000000000000000000000000000000000000000000000000000000000007f00000000000000000000000000000000000076a84fef008cdabe6409d2fe638b8a8a8a6040518863ffffffff1660e01b81526004016133779796959493929190614dd8565b610fbe848484612af1565b60356110ad8282614e6e565b60366110ad8282614e6e565b6043546001600160a01b0316600082156134cd576001600160a01b0386166000908152603c6020526040902054600160401b90046001600160401b031690505b60006134da87878761357f565b90508315610d4b576040516316667cd760e01b81526001600160a01b0384811660048301526024820187905288811660448301528781166064830152821515608483015260a482018490527f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff16906316667cd79060c401600060405180830381600087803b15801561356b57600080fd5b505af1158015612571573d6000803e3d6000fd5b604051637a420cef60e01b8152603560048201526001600160a01b037f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff811660248301527f0000000000000000000000000000000000000000000000000000000000000000151560448301527f00000000000000000000000000000000000076a84fef008cdabe6409d2fe638b811660648301528085166084830152831660a482015260c4810182905260009073f5fc7493fed883e3dc2e57bc24981ebbe0560d3890637a420cef9060e401602060405180830381865af4158015613668573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190612ae991906142b7565b60006020828403121561369e57600080fd5b81356001600160e01b031981168114610ee557600080fd5b6000602082840312156136c857600080fd5b5035919050565b60005b838110156136ea5781810151838201526020016136d2565b50506000910152565b60208152600082518060208401526137128160408501602087016136cf565b601f01601f19169190910160400192915050565b6001600160a01b0381168114610ab757600080fd5b6000806040838503121561374e57600080fd5b823561375981613726565b946020939093013593505050565b634e487b7160e01b600052604160045260246000fd5b6040516101c081016001600160401b03811182821017156137a0576137a0613767565b60405290565b604051601f8201601f191681016001600160401b03811182821017156137ce576137ce613767565b604052919050565b60006001600160401b038211156137ef576137ef613767565b50601f01601f191660200190565b6000806000806080858703121561381357600080fd5b843561381e81613726565b9350602085013561382e81613726565b92506040850135915060608501356001600160401b0381111561385057600080fd5b8501601f8101871361386157600080fd5b803561387461386f826137d6565b6137a6565b81815288602083850101111561388957600080fd5b8160208401602083013760006020838301015280935050505092959194509250565b8015158114610ab757600080fd5b6000806000606084860312156138ce57600080fd5b8335925060208401356138e0816138ab565b915060408401356138f081613726565b809150509250925092565b60008060006060848603121561391057600080fd5b833561391b81613726565b9250602084013561392b81613726565b929592945050506040919091013590565b60008083601f84011261394e57600080fd5b5081356001600160401b0381111561396557600080fd5b6020830191508360208260051b850101111561398057600080fd5b9250929050565b6000806000806040858703121561399d57600080fd5b84356001600160401b03808211156139b457600080fd5b6139c08883890161393c565b909650945060208701359150808211156139d957600080fd5b506139e68782880161393c565b95989497509550505050565b60008060208385031215613a0557600080fd5b82356001600160401b0380821115613a1c57600080fd5b818501915085601f830112613a3057600080fd5b813581811115613a3f57600080fd5b866020606083028501011115613a5457600080fd5b60209290920196919550909350505050565b60006040828403121561149057600080fd5b600080600080600060a08688031215613a9057600080fd5b8535613a9b81613726565b94506020860135613aab81613726565b935060408601356001600160401b03811115613ac657600080fd5b613ad28882890161393c565b9094509250613ae690508760608801613a66565b90509295509295909350565b6001600160401b0381168114610ab757600080fd5b600060208284031215613b1957600080fd5b8135610ee581613af2565b600080600060408486031215613b3957600080fd5b8335613b4481613726565b925060208401356001600160401b03811115613b5f57600080fd5b613b6b8682870161393c565b9497909650939450505050565b600060208284031215613b8a57600080fd5b8135610ee581613726565b600080600060808486031215613baa57600080fd5b8335613bb581613726565b925060208401359150613bcb8560408601613a66565b90509250925092565b60008060008060608587031215613bea57600080fd5b8435613bf581613726565b935060208501356001600160401b03811115613c1057600080fd5b613c1c8782880161393c565b9094509250506040850135613c30816138ab565b939692955090935050565b60008083601f840112613c4d57600080fd5b5081356001600160401b03811115613c6457600080fd5b60208301915083602082850101111561398057600080fd5b600080600060408486031215613c9157600080fd5b8335613c9c81613726565b925060208401356001600160401b03811115613cb757600080fd5b613b6b86828701613c3b565b60008060008060008060008060a0898b031215613cdf57600080fd5b8835613cea81613726565b97506020890135613cfa81613726565b965060408901356001600160401b0380821115613d1657600080fd5b613d228c838d0161393c565b909850965060608b0135915080821115613d3b57600080fd5b613d478c838d0161393c565b909650945060808b0135915080821115613d6057600080fd5b50613d6d8b828c01613c3b565b999c989b5096995094979396929594505050565b60008060408385031215613d9457600080fd5b8235613d9f81613726565b91506020830135613daf816138ab565b809150509250929050565b600080600060408486031215613dcf57600080fd5b83356001600160401b0380821115613de657600080fd5b818601915086601f830112613dfa57600080fd5b813581811115613e0957600080fd5b8760208260071b8501011115613e1e57600080fd5b602092830195509350508401356138f081613726565b634e487b7160e01b600052602160045260246000fd5b60208101601d8310613e5e57613e5e613e34565b91905290565b600080600060408486031215613e7957600080fd5b83356001600160401b03811115613e8f57600080fd5b613e9b8682870161393c565b90945092505060208401356138f081613726565b60008060008060608587031215613ec557600080fd5b8435613ed081613726565b93506020850135613ee081613726565b925060408501356001600160401b03811115613efb57600080fd5b6139e68782880161393c565b60008060008060608587031215613f1d57600080fd5b84356001600160401b03811115613f3357600080fd5b613f3f8782880161393c565b9095509350506020850135613f53816138ab565b91506040850135613c3081613726565b600080600060608486031215613f7857600080fd5b8335613f8381613726565b92506020840135613f9381613726565b915060408401356138f0816138ab565b600080600080600080600080600060c08a8c031215613fc157600080fd5b8935613fcc81613726565b985060208a0135613fdc81613726565b975060408a0135613fec81613726565b965060608a01356001600160401b038082111561400857600080fd5b6140148d838e01613c3b565b909850965060808c013591508082111561402d57600080fd5b6140398d838e01613c3b565b909650945060a08c013591508082111561405257600080fd5b5061405f8c828d01613c3b565b915080935050809150509295985092959850929598565b6000806040838503121561408957600080fd5b823591506020830135613daf81613726565b60008083601f8401126140ad57600080fd5b5081356001600160401b038111156140c457600080fd5b6020830191508360208260061b850101111561398057600080fd5b6000806000604084860312156140f457600080fd5b83356001600160401b0381111561410a57600080fd5b613e9b8682870161409b565b6000806040838503121561412957600080fd5b823561413481613726565b91506020830135613daf81613726565b6000806020838503121561415757600080fd5b82356001600160401b0381111561416d57600080fd5b6141798582860161409b565b90969095509350505050565b60008060008060008060a0878903121561419e57600080fd5b86356141a981613726565b955060208701356141b981613726565b9450604087013593506060870135925060808701356001600160401b038111156141e257600080fd5b6141ee89828a01613c3b565b979a9699509497509295939492505050565b60008060006040848603121561421557600080fd5b833561422081613726565b925060208401356001600160401b0381111561423b57600080fd5b613b6b8682870161409b565b9283526001600160a01b03919091166020830152604082015260600190565b600181811c9082168061427a57607f821691505b60208210810361149057634e487b7160e01b600052602260045260246000fd5b6000602082840312156142ac57600080fd5b8151610ee581613726565b6000602082840312156142c957600080fd5b8151610ee5816138ab565b60208082526031908201527f4552433732313a207472616e736665722063616c6c6572206973206e6f74206f6040820152701ddb995c881b9bdc88185c1c1c9bdd9959607a1b606082015260800190565b81835260006001600160fb1b0383111561433e57600080fd5b8260051b80836020870137939093016020019392505050565b858152606060208201526000614371606083018688614325565b8281036040840152614384818587614325565b98975050505050505050565b803563ffffffff811681146143a457600080fd5b919050565b80356001600160b81b03811681146143a457600080fd5b6040808252818101849052600090606080840187845b8881101561442c5763ffffffff806143ed84614390565b1684526020816143fe828601614390565b1690850152506001600160b81b036144178387016143a9565b168386015291830191908301906001016143d6565b505084810360208681019190915286518083528782019282019060005b81811015614488578451805163ffffffff90811685528582015116858501528701516001600160b81b0316878401529383019391850191600101614449565b50909a9950505050505050505050565b634e487b7160e01b600052603260045260246000fd5b60006101208201905084825283602083015260018060a01b03808451166040840152806020850151166060840152806040850151166080840152606084015160a0840152608084015160c08401528060a08501511660e08401528060c08501511661010084015250949350505050565b634e487b7160e01b600052601160045260246000fd5b6000600182016145465761454661451e565b5060010190565b602081526000612ae9602083018486614325565b60006020828403121561457357600080fd5b813565ffffffffffff81168114610ee557600080fd5b60006020828403121561459b57600080fd5b813560028110610ee557600080fd5b60028110610ab757610ab7613e34565b600060c082016145c9896145aa565b88835260206145d7896145aa565b8381018990526001600160a01b03888116604086015260c060608601528751928390528782019260e086019060005b8181101561462257855183529484019491840191600101614606565b50509616608085015250505065ffffffffffff9190911660a090910152949350505050565b60006020828403121561465957600080fd5b5051919050565b81835281816020850137506000828201602090810191909152601f909101601f19169091010190565b6001600160a01b03841681526040602082018190526000906146ae9083018486614660565b95945050505050565b6001600160a01b0389811682528816602082015260a0604082018190526000906146e4908301888a614325565b82810360608401526146f7818789614325565b9050828103608084015261470c818587614660565b9b9a5050505050505050505050565b6001600160a01b0386168152602080820186905260806040808401829052838201869052600092879160a08601855b898110156147b35763ffffffff8061476187614390565b16835280614770868801614390565b1683860152506001600160b81b036147898685016143a9565b168383015260608086013561479d816138ab565b151590830152938501939085019060010161474a565b506001600160a01b038816606088015294506128199350505050565b6040815260006147e3604083018587614325565b905060018060a01b0383166020830152949350505050565b60006020828403121561480d57600080fd5b81516001600160401b0381111561482357600080fd5b8201601f8101841361483457600080fd5b805161484261386f826137d6565b81815285602083850101111561485757600080fd5b6146ae8260208301602086016136cf565b6001600160a01b03868116825285811660208301528416604082015260806060820181905260009061489d9083018486614325565b979650505050505050565b878152600060018060a01b038089166020840152871515604084015260c060608401526148d960c084018789614325565b94151560808401529290921660a0909101525095945050505050565b6000806040838503121561490857600080fd5b505080516020909101519092909150565b6020808252602e908201527f436f6e747261637420696e7374616e63652068617320616c726561647920626560408201526d195b881a5b9a5d1a585b1a5e995960921b606082015260800190565b818352600060208085019450826000805b868110156149c25763ffffffff61498e84614390565b168852828401356001600160e01b0381168082146149aa578384fd5b89860152506040978801979290920191600101614978565b50959695505050505050565b6040815260006147e3604083018587614967565b602081526000612ae9602083018486614967565b6001600160801b0381168114610ab757600080fd5b6060808252810184905260008560808301825b87811015614a65578235614a31816149f6565b6001600160801b03908116835260209084820135614a4e816149f6565b169083015260409283019290910190600101614a1e565b5060209150838103828501528086518083528383019150838801925060005b81811015614ab857835180516001600160801b03908116855290860151168584015292840192604090920191600101614a84565b50506001600160a01b038616604086015292506146ae915050565b80516143a481613726565b81810381811115610a0b57610a0b61451e565b600060208284031215614b0357600080fd5b604051602081018181106001600160401b0382111715614b2557614b25613767565b6040529151825250919050565b80516143a4816149f6565b805164ffffffffff811681146143a457600080fd5b805161ffff811681146143a457600080fd5b60006101c08284031215614b7757600080fd5b614b7f61377d565b614b898484614af1565b8152614b9760208401614b32565b6020820152614ba860408401614b32565b6040820152614bb960608401614b32565b6060820152614bca60808401614b32565b6080820152614bdb60a08401614b3d565b60a0820152614bec60c08401614b52565b60c0820152614bfd60e08401614ad3565b60e0820152610100614c10818501614ad3565b90820152610120614c22848201614ad3565b90820152610140614c34848201614ad3565b90820152610160614c46848201614b32565b90820152610180614c58848201614ad3565b908201526101a0614c6a848201614b32565b908201529392505050565b614c7e886145aa565b878152614c8a876145aa565b866020820152600060018060a01b03808816604084015260c06060840152614cb660c084018789614325565b941660808301525065ffffffffffff9190911660a09091015295945050505050565b6001600160a01b0388168152608060208201819052600090614cfd908301888a614660565b8281036040840152614d10818789614660565b90508281036060840152614d25818587614660565b9a9950505050505050505050565b600060808201878352602087151581850152604060018060a01b03881681860152608060608601528286845260a08601905087935060005b87811015614d9a578435825283850135614d84816138ab565b1515828501529382019390820190600101614d6b565b509a9950505050505050505050565b60008060408385031215614dbc57600080fd5b8251614dc781613af2565b6020840151909250613daf81613af2565b8781526001600160a01b038781166020830152861515604083015285811660608301528416608082015260c060a08201819052600090614e1b9083018486614325565b9998505050505050505050565b601f821115610f2f57600081815260208120601f850160051c81016020861015614e4f5750805b601f850160051c820191505b81811015611bbe57828155600101614e5b565b81516001600160401b03811115614e8757614e87613767565b614e9b81614e958454614266565b84614e28565b602080601f831160018114614ed05760008415614eb85750858301515b600019600386901b1c1916600185901b178555611bbe565b600085815260208120601f198616915b82811015614eff57888601518255948401946001909101908401614ee0565b5085821015614f1d5787850151600019600388901b60f8161c191681555b5050505050600190811b0190555056fea2646970667358221220cfcff4a86a1551dd58ad635f4f0878d3e3826044694a52c2a37f30fcfb82208764736f6c63430008110033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb900000000000000000000000000000000000076a84fef008cdabe6409d2fe638b
-----Decoded View---------------
Arg [0] : pool (address): 0x6d596FdFD3381eBB5eCd526eBcAec8cC2BA019fF
Arg [1] : apeCoinStaking (address): 0x5954aB967Bc958940b7EB73ee84797Dc8a2AFbb9
Arg [2] : delegateRegistry (address): 0x00000000000076A84feF008CDAbe6409d2FE638B
-----Encoded View---------------
3 Constructor Arguments found :
Arg [0] : 0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff
Arg [1] : 0000000000000000000000005954ab967bc958940b7eb73ee84797dc8a2afbb9
Arg [2] : 00000000000000000000000000000000000076a84fef008cdabe6409d2fe638b
Loading...
Loading
Loading...
Loading
Net Worth in USD
$0.00
Net Worth in ETH
0
Multichain Portfolio | 33 Chains
| Chain | Token | Portfolio % | Price | Amount | Value |
|---|
Loading...
Loading
Loading...
Loading
Loading...
Loading
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.