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
View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Loading...
Loading
Loading...
Loading
Cross-Chain Transactions
Loading...
Loading
Contract Name:
PToken
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 {IERC20} from "../../dependencies/openzeppelin/contracts/IERC20.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 {IPToken} from "../../interfaces/IPToken.sol";
import {IRewardController} from "../../interfaces/IRewardController.sol";
import {IInitializablePToken} from "../../interfaces/IInitializablePToken.sol";
import {ScaledBalanceTokenBaseERC20} from "./base/ScaledBalanceTokenBaseERC20.sol";
import {IncentivizedERC20} from "./base/IncentivizedERC20.sol";
import {EIP712Base} from "./base/EIP712Base.sol";
import {XTokenType} from "../../interfaces/IXTokenType.sol";
import {ITimeLock} from "../../interfaces/ITimeLock.sol";
import {DataTypes} from "../libraries/types/DataTypes.sol";
import {ICApe} from "../../interfaces/ICApe.sol";
import {IAutoCompoundApe} from "../../interfaces/IAutoCompoundApe.sol";
/**
* @title ParaSpace ERC20 PToken
*
* @notice Implementation of the interest bearing token for the ParaSpace protocol
*/
contract PToken is
VersionedInitializable,
ScaledBalanceTokenBaseERC20,
EIP712Base,
IPToken
{
using WadRayMath for uint256;
using SafeCast for uint256;
using GPv2SafeERC20 for IERC20;
bytes32 public constant PERMIT_TYPEHASH =
keccak256(
"Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"
);
uint256 public constant PTOKEN_REVISION = 149;
address internal _treasury;
address internal _underlyingAsset;
uint256[50] private __gap;
/// @inheritdoc VersionedInitializable
function getRevision() internal pure virtual override returns (uint256) {
return PTOKEN_REVISION;
}
/**
* @dev Constructor.
* @param pool The address of the Pool contract
*/
constructor(IPool pool)
ScaledBalanceTokenBaseERC20(pool, "PTOKEN_IMPL", "PTOKEN_IMPL", 0)
EIP712Base()
{
// Intentionally left blank
}
/// @inheritdoc IInitializablePToken
function initialize(
IPool initializingPool,
address treasury,
address underlyingAsset,
IRewardController incentivesController,
uint8 pTokenDecimals,
string calldata pTokenName,
string calldata pTokenSymbol,
bytes calldata params
) external override initializer {
require(initializingPool == POOL, Errors.POOL_ADDRESSES_DO_NOT_MATCH);
_setName(pTokenName);
_setSymbol(pTokenSymbol);
_setDecimals(pTokenDecimals);
require(underlyingAsset != address(0), Errors.ZERO_ADDRESS_NOT_VALID);
_treasury = treasury;
_underlyingAsset = underlyingAsset;
_rewardController = incentivesController;
_domainSeparator = _calculateDomainSeparator();
emit Initialized(
underlyingAsset,
address(POOL),
treasury,
address(incentivesController),
pTokenDecimals,
pTokenName,
pTokenSymbol,
params
);
}
/// @inheritdoc IPToken
function mint(
address caller,
address onBehalfOf,
uint256 amount,
uint256 index
) external virtual override onlyPool returns (bool) {
return _mintScaled(caller, onBehalfOf, amount, index);
}
/// @inheritdoc IPToken
function burn(
address from,
address receiverOfUnderlying,
uint256 amount,
uint256 index,
DataTypes.TimeLockParams calldata timeLockParams
) external virtual override onlyPool {
_burnScaled(from, receiverOfUnderlying, amount, index);
if (receiverOfUnderlying != address(this)) {
if (timeLockParams.releaseTime != 0) {
ITimeLock timeLock = POOL.TIME_LOCK();
uint256[] memory amounts = new uint256[](1);
amounts[0] = amount;
timeLock.createAgreement(
DataTypes.AssetType.ERC20,
timeLockParams.actionType,
_underlyingAsset,
amounts,
receiverOfUnderlying,
timeLockParams.releaseTime
);
receiverOfUnderlying = address(timeLock);
}
IERC20(_underlyingAsset).safeTransfer(receiverOfUnderlying, amount);
}
}
/// @inheritdoc IPToken
function mintToTreasury(uint256 amount, uint256 index)
external
virtual
override
onlyPool
{
if (amount == 0) {
return;
}
_mintScaled(address(POOL), _treasury, amount, index);
}
/// @inheritdoc IPToken
function transferOnLiquidation(
address from,
address to,
uint256 value
) external virtual override onlyPool {
_transfer(from, to, value, false);
}
/// @inheritdoc IERC20
function balanceOf(address user)
public
view
virtual
override(IncentivizedERC20, IERC20)
returns (uint256)
{
return
super.balanceOf(user).rayMul(
POOL.getReserveNormalizedIncome(_underlyingAsset)
);
}
/// @inheritdoc IERC20
function totalSupply()
public
view
virtual
override(IncentivizedERC20, IERC20)
returns (uint256)
{
uint256 currentSupplyScaled = super.totalSupply();
if (currentSupplyScaled == 0) {
return 0;
}
return
currentSupplyScaled.rayMul(
POOL.getReserveNormalizedIncome(_underlyingAsset)
);
}
/// @inheritdoc IPToken
function RESERVE_TREASURY_ADDRESS()
external
view
override
returns (address)
{
return _treasury;
}
/// @inheritdoc IPToken
function UNDERLYING_ASSET_ADDRESS()
external
view
override
returns (address)
{
return _underlyingAsset;
}
/// @inheritdoc IPToken
function transferUnderlyingTo(
address target,
uint256 amount,
DataTypes.TimeLockParams calldata timeLockParams
) external virtual override onlyPool {
if (timeLockParams.releaseTime != 0) {
ITimeLock timeLock = POOL.TIME_LOCK();
uint256[] memory amounts = new uint256[](1);
amounts[0] = amount;
timeLock.createAgreement(
DataTypes.AssetType.ERC20,
timeLockParams.actionType,
_underlyingAsset,
amounts,
target,
timeLockParams.releaseTime
);
target = address(timeLock);
}
IERC20(_underlyingAsset).safeTransfer(target, amount);
}
/// @inheritdoc IPToken
function handleRepayment(address user, uint256 amount)
external
virtual
override
onlyPool
{
// Intentionally left blank
}
/// @inheritdoc IPToken
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external override {
require(owner != address(0), Errors.ZERO_ADDRESS_NOT_VALID);
//solium-disable-next-line
require(block.timestamp <= deadline, Errors.INVALID_EXPIRATION);
uint256 currentValidNonce = _nonces[owner];
bytes32 digest = keccak256(
abi.encodePacked(
"\x19\x01",
DOMAIN_SEPARATOR(),
keccak256(
abi.encode(
PERMIT_TYPEHASH,
owner,
spender,
value,
currentValidNonce,
deadline
)
)
)
);
require(owner == ecrecover(digest, v, r, s), Errors.INVALID_SIGNATURE);
_nonces[owner] = currentValidNonce + 1;
_approve(owner, spender, value);
}
/**
* @notice Transfers the pTokens 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 amount The amount getting transferred
* @param validate True if the transfer needs to be validated, false otherwise
**/
function _transfer(
address from,
address to,
uint256 amount,
bool validate
) internal virtual {
address underlyingAsset = _underlyingAsset;
uint256 index = POOL.getReserveNormalizedIncome(underlyingAsset);
uint256 fromBalanceBefore = super.balanceOf(from).rayMul(index);
uint256 toBalanceBefore = super.balanceOf(to).rayMul(index);
super._transferScaled(from, to, amount, index);
if (validate) {
POOL.finalizeTransfer(
underlyingAsset,
from,
to,
false,
amount,
fromBalanceBefore,
toBalanceBefore
);
}
emit Transfer(from, to, amount);
}
/**
* @notice Overrides the parent _transfer to force validated transfer() and transferFrom()
* @param from The source address
* @param to The destination address
* @param amount The amount getting transferred
**/
function _transfer(
address from,
address to,
uint128 amount
) internal virtual override {
_transfer(from, to, amount, true);
}
/**
* @dev Overrides the base function to fully implement IPToken
* @dev see `IncentivizedERC20.DOMAIN_SEPARATOR()` for more detailed documentation
*/
function DOMAIN_SEPARATOR()
public
view
override(IPToken, EIP712Base)
returns (bytes32)
{
return super.DOMAIN_SEPARATOR();
}
/**
* @dev Overrides the base function to fully implement IPToken
* @dev see `IncentivizedERC20.nonces()` for more detailed documentation
*/
function nonces(address owner)
public
view
override(IPToken, EIP712Base)
returns (uint256)
{
return super.nonces(owner);
}
/// @inheritdoc EIP712Base
function _EIP712BaseId() internal view override returns (string memory) {
return name();
}
/// @inheritdoc IPToken
function rescueTokens(
address token,
address to,
uint256 amount
) external override onlyPoolAdmin {
require(token != _underlyingAsset, Errors.UNDERLYING_CANNOT_BE_RESCUED);
IERC20(token).safeTransfer(to, amount);
}
function getXTokenType()
external
pure
virtual
override
returns (XTokenType)
{
return XTokenType.PToken;
}
function claimUnderlying(
address timeLockV1,
address cApeV1,
address cApeV2,
address apeCoin,
uint256[] calldata agreementIds
) external virtual onlyPool returns (uint256) {
address underlyingAsset = _underlyingAsset;
bool isCApeV2 = underlyingAsset == address(cApeV2);
uint256 beforeBalance = isCApeV2
? IERC20(cApeV1).balanceOf(address(this))
: IERC20(underlyingAsset).balanceOf(address(this));
ITimeLock(timeLockV1).claim(agreementIds);
if (!isCApeV2) {
return
IERC20(underlyingAsset).balanceOf(address(this)) -
beforeBalance;
}
uint256 diff = IERC20(cApeV1).balanceOf(address(this)) - beforeBalance;
if (diff == 0) {
return 0;
}
IAutoCompoundApe(cApeV1).withdraw(diff);
if (IERC20(apeCoin).allowance(address(this), address(cApeV2)) == 0) {
IERC20(apeCoin).approve(cApeV2, type(uint256).max);
}
IAutoCompoundApe(cApeV2).deposit(address(this), diff);
return diff;
}
}// SPDX-License-Identifier: LGPL-3.0-or-later
pragma solidity ^0.8.0;
import {IERC20} from "../../openzeppelin/contracts/IERC20.sol";
/// @title Gnosis Protocol v2 Safe ERC20 Transfer Library
/// @author Gnosis Developers
/// @dev Gas-efficient version of Openzeppelin's SafeERC20 contract.
library GPv2SafeERC20 {
/// @dev Wrapper around a call to the ERC20 function `transfer` that reverts
/// also when the token returns `false`.
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
bytes4 selector_ = token.transfer.selector;
// solhint-disable-next-line no-inline-assembly
assembly {
let freeMemoryPointer := mload(0x40)
mstore(freeMemoryPointer, selector_)
mstore(
add(freeMemoryPointer, 4),
and(to, 0xffffffffffffffffffffffffffffffffffffffff)
)
mstore(add(freeMemoryPointer, 36), value)
if iszero(call(gas(), token, 0, freeMemoryPointer, 68, 0, 0)) {
returndatacopy(0, 0, returndatasize())
revert(0, returndatasize())
}
}
require(getLastTransferResult(token), "GPv2: failed transfer");
}
/// @dev Wrapper around a call to the ERC20 function `transferFrom` that
/// reverts also when the token returns `false`.
function safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value
) internal {
bytes4 selector_ = token.transferFrom.selector;
// solhint-disable-next-line no-inline-assembly
assembly {
let freeMemoryPointer := mload(0x40)
mstore(freeMemoryPointer, selector_)
mstore(
add(freeMemoryPointer, 4),
and(from, 0xffffffffffffffffffffffffffffffffffffffff)
)
mstore(
add(freeMemoryPointer, 36),
and(to, 0xffffffffffffffffffffffffffffffffffffffff)
)
mstore(add(freeMemoryPointer, 68), value)
if iszero(call(gas(), token, 0, freeMemoryPointer, 100, 0, 0)) {
returndatacopy(0, 0, returndatasize())
revert(0, returndatasize())
}
}
require(getLastTransferResult(token), "GPv2: failed transferFrom");
}
/// @dev Verifies that the last return was a successful `transfer*` call.
/// This is done by checking that the return data is either empty, or
/// is a valid ABI encoded boolean.
function getLastTransferResult(IERC20 token)
private
view
returns (bool success)
{
// NOTE: Inspecting previous return data requires assembly. Note that
// we write the return data to memory 0 in the case where the return
// data size is 32, this is OK since the first 64 bytes of memory are
// reserved by Solidy as a scratch space that can be used within
// assembly blocks.
// <https://docs.soliditylang.org/en/v0.7.6/internals/layout_in_memory.html>
// solhint-disable-next-line no-inline-assembly
assembly {
/// @dev Revert with an ABI encoded Solidity error with a message
/// that fits into 32-bytes.
///
/// An ABI encoded Solidity error has the following memory layout:
///
/// ------------+----------------------------------
/// byte range | value
/// ------------+----------------------------------
/// 0x00..0x04 | selector("Error(string)")
/// 0x04..0x24 | string offset (always 0x20)
/// 0x24..0x44 | string length
/// 0x44..0x64 | string value, padded to 32-bytes
function revertWithMessage(length, message) {
mstore(0x00, "\x08\xc3\x79\xa0")
mstore(0x04, 0x20)
mstore(0x24, length)
mstore(0x44, message)
revert(0x00, 0x64)
}
switch returndatasize()
// Non-standard ERC20 transfer without return.
case 0 {
// NOTE: When the return data size is 0, verify that there
// is code at the address. This is done in order to maintain
// compatibility with Solidity calling conventions.
// <https://docs.soliditylang.org/en/v0.7.6/control-structures.html#external-function-calls>
if iszero(extcodesize(token)) {
revertWithMessage(20, "GPv2: not a contract")
}
success := 1
}
// Standard ERC20 transfer returning boolean success value.
case 32 {
returndatacopy(0, 0, returndatasize())
// NOTE: For ABI encoding v1, any non-zero value is accepted
// as `true` for a boolean. In order to stay compatible with
// OpenZeppelin's `SafeERC20` library which is known to work
// with the existing ERC20 implementation we care about,
// make sure we return success for any non-zero return value
// from the `transfer*` call.
success := iszero(iszero(mload(0)))
}
default {
revertWithMessage(31, "GPv2: malformed transfer result")
}
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (utils/Address.sol)
pragma solidity ^0.8.0;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/*
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with GSN meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address payable) {
return payable(msg.sender);
}
function _msgData() internal view virtual returns (bytes memory) {
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
return msg.data;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/
abstract contract ERC165 is IERC165 {
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override
returns (bool)
{
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC721/ERC721.sol)
pragma solidity ^0.8.0;
import "./IERC721.sol";
import "./IERC721Receiver.sol";
import "./IERC721Metadata.sol";
import "./Address.sol";
import "./Context.sol";
import "./Strings.sol";
import "./ERC165.sol";
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension, but not including the Enumerable extension, which is available separately as
* {ERC721Enumerable}.
*/
contract ERC721 is Context, ERC165, IERC721, IERC721Metadata {
using Address for address;
using Strings for uint256;
// Token name
string private _name;
// Token symbol
string private _symbol;
// Mapping from token ID to owner address
mapping(uint256 => address) private _owners;
// Mapping owner address to token count
mapping(address => uint256) private _balances;
// Mapping from token ID to approved address
mapping(uint256 => address) private _tokenApprovals;
// Mapping from owner to operator approvals
mapping(address => mapping(address => bool)) private _operatorApprovals;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC165)
returns (bool)
{
return
interfaceId == type(IERC721).interfaceId ||
interfaceId == type(IERC721Metadata).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/
function balanceOf(address owner)
public
view
virtual
override
returns (uint256)
{
require(
owner != address(0),
"ERC721: address zero is not a valid owner"
);
return _balances[owner];
}
/**
* @dev See {IERC721-ownerOf}.
*/
function ownerOf(uint256 tokenId)
public
view
virtual
override
returns (address)
{
address owner = _owners[tokenId];
require(
owner != address(0),
"ERC721: owner query for nonexistent token"
);
return owner;
}
/**
* @dev See {IERC721Metadata-name}.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/
function tokenURI(uint256 tokenId)
public
view
virtual
override
returns (string memory)
{
require(
_exists(tokenId),
"ERC721Metadata: URI query for nonexistent token"
);
string memory baseURI = _baseURI();
return
bytes(baseURI).length > 0
? string(abi.encodePacked(baseURI, tokenId.toString()))
: "";
}
/**
* @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
* token will be the concatenation of the `baseURI` and the `tokenId`. Empty
* by default, can be overridden in child contracts.
*/
function _baseURI() internal view virtual returns (string memory) {
return "";
}
/**
* @dev See {IERC721-approve}.
*/
function approve(address to, uint256 tokenId) public virtual override {
address owner = ERC721.ownerOf(tokenId);
require(to != owner, "ERC721: approval to current owner");
require(
_msgSender() == owner || isApprovedForAll(owner, _msgSender()),
"ERC721: approve caller is not owner nor approved for all"
);
_approve(to, tokenId);
}
/**
* @dev See {IERC721-getApproved}.
*/
function getApproved(uint256 tokenId)
public
view
virtual
override
returns (address)
{
require(
_exists(tokenId),
"ERC721: approved query for nonexistent token"
);
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/
function setApprovalForAll(address operator, bool approved)
public
virtual
override
{
_setApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/
function isApprovedForAll(address owner, address operator)
public
view
virtual
override
returns (bool)
{
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) public virtual override {
//solhint-disable-next-line max-line-length
require(
_isApprovedOrOwner(_msgSender(), tokenId),
"ERC721: transfer caller is not owner nor approved"
);
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId
) public virtual override {
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes memory _data
) public virtual override {
require(
_isApprovedOrOwner(_msgSender(), tokenId),
"ERC721: transfer caller is not owner nor approved"
);
_safeTransfer(from, to, tokenId, _data);
}
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* `_data` is additional data, it has no specified format and it is sent in call to `to`.
*
* This internal function is equivalent to {safeTransferFrom}, and can be used to e.g.
* implement alternative mechanisms to perform token transfer, such as signature-based.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeTransfer(
address from,
address to,
uint256 tokenId,
bytes memory _data
) internal virtual {
_transfer(from, to, tokenId);
require(
_checkOnERC721Received(from, to, tokenId, _data),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @dev Returns whether `tokenId` exists.
*
* Tokens can be managed by their owner or approved accounts via {approve} or {setApprovalForAll}.
*
* Tokens start existing when they are minted (`_mint`),
* and stop existing when they are burned (`_burn`).
*/
function _exists(uint256 tokenId) internal view virtual returns (bool) {
return _owners[tokenId] != address(0);
}
/**
* @dev Returns whether `spender` is allowed to manage `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function _isApprovedOrOwner(address spender, uint256 tokenId)
internal
view
virtual
returns (bool)
{
require(
_exists(tokenId),
"ERC721: operator query for nonexistent token"
);
address owner = ERC721.ownerOf(tokenId);
return (spender == owner ||
isApprovedForAll(owner, spender) ||
getApproved(tokenId) == spender);
}
/**
* @dev Safely mints `tokenId` and transfers it to `to`.
*
* Requirements:
*
* - `tokenId` must not exist.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function _safeMint(address to, uint256 tokenId) internal virtual {
_safeMint(to, tokenId, "");
}
/**
* @dev Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
* forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
*/
function _safeMint(
address to,
uint256 tokenId,
bytes memory _data
) internal virtual {
_mint(to, tokenId);
require(
_checkOnERC721Received(address(0), to, tokenId, _data),
"ERC721: transfer to non ERC721Receiver implementer"
);
}
/**
* @dev Mints `tokenId` and transfers it to `to`.
*
* WARNING: Usage of this method is discouraged, use {_safeMint} whenever possible
*
* Requirements:
*
* - `tokenId` must not exist.
* - `to` cannot be the zero address.
*
* Emits a {Transfer} event.
*/
function _mint(address to, uint256 tokenId) internal virtual {
require(to != address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId);
_balances[to] += 1;
_owners[tokenId] = to;
emit Transfer(address(0), to, tokenId);
_afterTokenTransfer(address(0), to, tokenId);
}
/**
* @dev Destroys `tokenId`.
* The approval is cleared when the token is burned.
*
* Requirements:
*
* - `tokenId` must exist.
*
* Emits a {Transfer} event.
*/
function _burn(uint256 tokenId) internal virtual {
address owner = ERC721.ownerOf(tokenId);
_beforeTokenTransfer(owner, address(0), tokenId);
// Clear approvals
_approve(address(0), tokenId);
_balances[owner] -= 1;
delete _owners[tokenId];
emit Transfer(owner, address(0), tokenId);
_afterTokenTransfer(owner, address(0), tokenId);
}
/**
* @dev Transfers `tokenId` from `from` to `to`.
* As opposed to {transferFrom}, this imposes no restrictions on msg.sender.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
*
* Emits a {Transfer} event.
*/
function _transfer(
address from,
address to,
uint256 tokenId
) internal virtual {
require(
ERC721.ownerOf(tokenId) == from,
"ERC721: transfer from incorrect owner"
);
require(to != address(0), "ERC721: transfer to the zero address");
_beforeTokenTransfer(from, to, tokenId);
// Clear approvals from the previous owner
_approve(address(0), tokenId);
_balances[from] -= 1;
_balances[to] += 1;
_owners[tokenId] = to;
emit Transfer(from, to, tokenId);
_afterTokenTransfer(from, to, tokenId);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits a {Approval} event.
*/
function _approve(address to, uint256 tokenId) internal virtual {
_tokenApprovals[tokenId] = to;
emit Approval(ERC721.ownerOf(tokenId), to, tokenId);
}
/**
* @dev Approve `operator` to operate on all of `owner` tokens
*
* Emits a {ApprovalForAll} event.
*/
function _setApprovalForAll(
address owner,
address operator,
bool approved
) internal virtual {
require(owner != operator, "ERC721: approve to caller");
_operatorApprovals[owner][operator] = approved;
emit ApprovalForAll(owner, operator, approved);
}
/**
* @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target address.
* The call is not executed if the target address is not a contract.
*
* @param from address representing the previous owner of the given token ID
* @param to target address that will receive the tokens
* @param tokenId uint256 ID of the token to be transferred
* @param _data bytes optional data to send along with the call
* @return bool whether the call correctly returned the expected magic value
*/
function _checkOnERC721Received(
address from,
address to,
uint256 tokenId,
bytes memory _data
) private returns (bool) {
if (to.isContract()) {
try
IERC721Receiver(to).onERC721Received(
_msgSender(),
from,
tokenId,
_data
)
returns (bytes4 retval) {
return retval == IERC721Receiver.onERC721Received.selector;
} catch (bytes memory reason) {
if (reason.length == 0) {
revert(
"ERC721: transfer to non ERC721Receiver implementer"
);
} else {
assembly {
revert(add(32, reason), mload(reason))
}
}
}
} else {
return true;
}
}
/**
* @dev Hook that is called before any token transfer. This includes minting
* and burning.
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be
* transferred to `to`.
* - When `from` is zero, `tokenId` will be minted for `to`.
* - When `to` is zero, ``from``'s `tokenId` will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual {}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual {}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/ERC721Enumerable.sol)
pragma solidity ^0.8.0;
import "./ERC721.sol";
import "./IERC721Enumerable.sol";
/**
* @dev This implements an optional extension of {ERC721} defined in the EIP that adds
* enumerability of all the token ids in the contract as well as all token ids owned by each
* account.
*/
abstract contract ERC721Enumerable is ERC721, IERC721Enumerable {
// Mapping from owner to list of owned token IDs
mapping(address => mapping(uint256 => uint256)) private _ownedTokens;
// Mapping from token ID to index of the owner tokens list
mapping(uint256 => uint256) private _ownedTokensIndex;
// Array with all token ids, used for enumeration
uint256[] private _allTokens;
// Mapping from token id to position in the allTokens array
mapping(uint256 => uint256) private _allTokensIndex;
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId)
public
view
virtual
override(ERC721)
returns (bool)
{
return
interfaceId == type(IERC721Enumerable).interfaceId ||
super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721Enumerable-tokenOfOwnerByIndex}.
*/
function tokenOfOwnerByIndex(address owner, uint256 index)
public
view
virtual
override
returns (uint256)
{
require(
index < ERC721.balanceOf(owner),
"ERC721Enumerable: owner index out of bounds"
);
return _ownedTokens[owner][index];
}
/**
* @dev See {IERC721Enumerable-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _allTokens.length;
}
/**
* @dev See {IERC721Enumerable-tokenByIndex}.
*/
function tokenByIndex(uint256 index)
public
view
virtual
override
returns (uint256)
{
require(
index < ERC721Enumerable.totalSupply(),
"ERC721Enumerable: global index out of bounds"
);
return _allTokens[index];
}
/**
* @dev Hook that is called before any token transfer. This includes minting
* and burning.
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, ``from``'s `tokenId` will be
* transferred to `to`.
* - When `from` is zero, `tokenId` will be minted for `to`.
* - When `to` is zero, ``from``'s `tokenId` will be burned.
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 tokenId
) internal virtual override {
super._beforeTokenTransfer(from, to, tokenId);
if (from == address(0)) {
_addTokenToAllTokensEnumeration(tokenId);
} else if (from != to) {
_removeTokenFromOwnerEnumeration(from, tokenId);
}
if (to == address(0)) {
_removeTokenFromAllTokensEnumeration(tokenId);
} else if (to != from) {
_addTokenToOwnerEnumeration(to, tokenId);
}
}
/**
* @dev Private function to add a token to this extension's ownership-tracking data structures.
* @param to address representing the new owner of the given token ID
* @param tokenId uint256 ID of the token to be added to the tokens list of the given address
*/
function _addTokenToOwnerEnumeration(address to, uint256 tokenId) private {
uint256 length = ERC721.balanceOf(to);
_ownedTokens[to][length] = tokenId;
_ownedTokensIndex[tokenId] = length;
}
/**
* @dev Private function to add a token to this extension's token tracking data structures.
* @param tokenId uint256 ID of the token to be added to the tokens list
*/
function _addTokenToAllTokensEnumeration(uint256 tokenId) private {
_allTokensIndex[tokenId] = _allTokens.length;
_allTokens.push(tokenId);
}
/**
* @dev Private function to remove a token from this extension's ownership-tracking data structures. Note that
* while the token is not assigned a new owner, the `_ownedTokensIndex` mapping is _not_ updated: this allows for
* gas optimizations e.g. when performing a transfer operation (avoiding double writes).
* This has O(1) time complexity, but alters the order of the _ownedTokens array.
* @param from address representing the previous owner of the given token ID
* @param tokenId uint256 ID of the token to be removed from the tokens list of the given address
*/
function _removeTokenFromOwnerEnumeration(address from, uint256 tokenId)
private
{
// To prevent a gap in from's tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = ERC721.balanceOf(from) - 1;
uint256 tokenIndex = _ownedTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary
if (tokenIndex != lastTokenIndex) {
uint256 lastTokenId = _ownedTokens[from][lastTokenIndex];
_ownedTokens[from][tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
}
// This also deletes the contents at the last position of the array
delete _ownedTokensIndex[tokenId];
delete _ownedTokens[from][lastTokenIndex];
}
/**
* @dev Private function to remove a token from this extension's token tracking data structures.
* This has O(1) time complexity, but alters the order of the _allTokens array.
* @param tokenId uint256 ID of the token to be removed from the tokens list
*/
function _removeTokenFromAllTokensEnumeration(uint256 tokenId) private {
// To prevent a gap in the tokens array, we store the last token in the index of the token to delete, and
// then delete the last slot (swap and pop).
uint256 lastTokenIndex = _allTokens.length - 1;
uint256 tokenIndex = _allTokensIndex[tokenId];
// When the token to delete is the last token, the swap operation is unnecessary. However, since this occurs so
// rarely (when the last minted token is burnt) that we still do the swap here to avoid the gas cost of adding
// an 'if' statement (like in _removeTokenFromOwnerEnumeration)
uint256 lastTokenId = _allTokens[lastTokenIndex];
_allTokens[tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_allTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
// This also deletes the contents at the last position of the array
delete _allTokensIndex[tokenId];
_allTokens.pop();
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev 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: agpl-3.0
pragma solidity ^0.8.0;
import {IERC20} from "./IERC20.sol";
interface IERC20Detailed is IERC20 {
function name() external view returns (string memory);
function symbol() external view returns (string memory);
function decimals() external view returns (uint8);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721.sol)
pragma solidity ^0.8.0;
import "./IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/
interface IERC721 {
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/
event Transfer(
address indexed from,
address indexed to,
uint256 indexed tokenId
);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/
event Approval(
address indexed owner,
address indexed approved,
uint256 indexed tokenId
);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/
event ApprovalForAll(
address indexed owner,
address indexed operator,
bool approved
);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/
function balanceOf(address owner) external view returns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function ownerOf(uint256 tokenId) external view returns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId,
bytes calldata data
) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be have been allowed to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/
function safeTransferFrom(
address from,
address to,
uint256 tokenId
) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Usage of this method is discouraged, use {safeTransferFrom} whenever possible.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address from,
address to,
uint256 tokenId
) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/
function approve(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the caller.
*
* Emits an {ApprovalForAll} event.
*/
function setApprovalForAll(address operator, bool _approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/
function getApproved(uint256 tokenId)
external
view
returns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/
function isApprovedForAll(address owner, address operator)
external
view
returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC721/extensions/IERC721Enumerable.sol)
pragma solidity ^0.8.0;
import "./IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional enumeration extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Enumerable is IERC721 {
/**
* @dev Returns the total amount of tokens stored by the contract.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns a token ID owned by `owner` at a given `index` of its token list.
* Use along with {balanceOf} to enumerate all of ``owner``'s tokens.
*/
function tokenOfOwnerByIndex(address owner, uint256 index)
external
view
returns (uint256);
/**
* @dev Returns a token ID at a given `index` of all the tokens stored by the contract.
* Use along with {totalSupply} to enumerate all tokens.
*/
function tokenByIndex(uint256 index) external view returns (uint256);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol)
pragma solidity ^0.8.0;
import "./IERC721.sol";
/**
* @title ERC-721 Non-Fungible Token Standard, optional metadata extension
* @dev See https://eips.ethereum.org/EIPS/eip-721
*/
interface IERC721Metadata is IERC721 {
/**
* @dev Returns the token collection name.
*/
function name() external view returns (string memory);
/**
* @dev Returns the token collection symbol.
*/
function symbol() external view returns (string memory);
/**
* @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token.
*/
function tokenURI(uint256 tokenId) external view returns (string memory);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721Receiver.sol)
pragma solidity ^0.8.0;
/**
* @title ERC721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC721 asset contracts.
*/
interface IERC721Receiver {
/**
* @dev Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom}
* by `operator` from `from`, this function is called.
*
* It must return its Solidity selector to confirm the token transfer.
* If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted.
*
* The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.selector`.
*/
function onERC721Received(
address operator,
address from,
uint256 tokenId,
bytes calldata data
) external returns (bytes4);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "./Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
contract Ownable is Context {
address private _owner;
event OwnershipTransferred(
address indexed previousOwner,
address indexed newOwner
);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
address msgSender = _msgSender();
_owner = msgSender;
emit OwnershipTransferred(address(0), msgSender);
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view returns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
require(_owner == _msgSender(), "Ownable: caller is not the owner");
_;
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
emit OwnershipTransferred(_owner, address(0));
_owner = address(0);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(
newOwner != address(0),
"Ownable: new owner is the zero address"
);
emit OwnershipTransferred(_owner, newOwner);
_owner = newOwner;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/math/SafeCast.sol)
pragma solidity ^0.8.0;
/**
* @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow
* checks.
*
* Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
* easily result in undesired exploitation or bugs, since developers usually
* assume that overflows raise errors. `SafeCast` restores this intuition by
* reverting the transaction when such an operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*
* Can be combined with {SafeMath} and {SignedSafeMath} to extend it to smaller types, by performing
* all math on `uint256` and `int256` and then downcasting.
*/
library SafeCast {
/**
* @dev Returns the downcasted uint224 from uint256, reverting on
* overflow (when the input is greater than largest uint224).
*
* Counterpart to Solidity's `uint224` operator.
*
* Requirements:
*
* - input must fit into 224 bits
*/
function toUint224(uint256 value) internal pure returns (uint224) {
require(
value <= type(uint224).max,
"SafeCast: value doesn't fit in 224 bits"
);
return uint224(value);
}
/**
* @dev Returns the downcasted uint184 from uint256, reverting on
* overflow (when the input is greater than largest uint184).
*
* Counterpart to Solidity's `uint184` operator.
*
* Requirements:
*
* - input must fit into 184 bits
*
* _Available since v4.7._
*/
function toUint184(uint256 value) internal pure returns (uint184) {
require(value <= type(uint184).max, "SafeCast: value doesn't fit in 184 bits");
return uint184(value);
}
/**
* @dev Returns the downcasted uint128 from uint256, reverting on
* overflow (when the input is greater than largest uint128).
*
* Counterpart to Solidity's `uint128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/
function toUint128(uint256 value) internal pure returns (uint128) {
require(
value <= type(uint128).max,
"SafeCast: value doesn't fit in 128 bits"
);
return uint128(value);
}
/**
* @dev Returns the downcasted uint96 from uint256, reverting on
* overflow (when the input is greater than largest uint96).
*
* Counterpart to Solidity's `uint96` operator.
*
* Requirements:
*
* - input must fit into 96 bits
*/
function toUint96(uint256 value) internal pure returns (uint96) {
require(
value <= type(uint96).max,
"SafeCast: value doesn't fit in 96 bits"
);
return uint96(value);
}
/**
* @dev Returns the downcasted uint64 from uint256, reverting on
* overflow (when the input is greater than largest uint64).
*
* Counterpart to Solidity's `uint64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*/
function toUint64(uint256 value) internal pure returns (uint64) {
require(
value <= type(uint64).max,
"SafeCast: value doesn't fit in 64 bits"
);
return uint64(value);
}
/**
* @dev Returns the downcasted uint48 from uint256, reverting on
* overflow (when the input is greater than largest uint48).
*
* Counterpart to Solidity's `uint48` operator.
*
* Requirements:
*
* - input must fit into 48 bits
*
* _Available since v4.7._
*/
function toUint48(uint256 value) internal pure returns (uint48) {
require(value <= type(uint48).max, "SafeCast: value doesn't fit in 48 bits");
return uint48(value);
}
/**
* @dev Returns the downcasted uint32 from uint256, reverting on
* overflow (when the input is greater than largest uint32).
*
* Counterpart to Solidity's `uint32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*/
function toUint32(uint256 value) internal pure returns (uint32) {
require(
value <= type(uint32).max,
"SafeCast: value doesn't fit in 32 bits"
);
return uint32(value);
}
/**
* @dev Returns the downcasted uint16 from uint256, reverting on
* overflow (when the input is greater than largest uint16).
*
* Counterpart to Solidity's `uint16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*/
function toUint16(uint256 value) internal pure returns (uint16) {
require(
value <= type(uint16).max,
"SafeCast: value doesn't fit in 16 bits"
);
return uint16(value);
}
/**
* @dev Returns the downcasted uint8 from uint256, reverting on
* overflow (when the input is greater than largest uint8).
*
* Counterpart to Solidity's `uint8` operator.
*
* Requirements:
*
* - input must fit into 8 bits.
*/
function toUint8(uint256 value) internal pure returns (uint8) {
require(
value <= type(uint8).max,
"SafeCast: value doesn't fit in 8 bits"
);
return uint8(value);
}
/**
* @dev Converts a signed int256 into an unsigned uint256.
*
* Requirements:
*
* - input must be greater than or equal to 0.
*/
function toUint256(int256 value) internal pure returns (uint256) {
require(value >= 0, "SafeCast: value must be positive");
return uint256(value);
}
/**
* @dev Returns the downcasted int128 from int256, reverting on
* overflow (when the input is less than smallest int128 or
* greater than largest int128).
*
* Counterpart to Solidity's `int128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*
* _Available since v3.1._
*/
function toInt128(int256 value) internal pure returns (int128) {
require(
value >= type(int128).min && value <= type(int128).max,
"SafeCast: value doesn't fit in 128 bits"
);
return int128(value);
}
/**
* @dev Returns the downcasted int64 from int256, reverting on
* overflow (when the input is less than smallest int64 or
* greater than largest int64).
*
* Counterpart to Solidity's `int64` operator.
*
* Requirements:
*
* - input must fit into 64 bits
*
* _Available since v3.1._
*/
function toInt64(int256 value) internal pure returns (int64) {
require(
value >= type(int64).min && value <= type(int64).max,
"SafeCast: value doesn't fit in 64 bits"
);
return int64(value);
}
/**
* @dev Returns the downcasted int32 from int256, reverting on
* overflow (when the input is less than smallest int32 or
* greater than largest int32).
*
* Counterpart to Solidity's `int32` operator.
*
* Requirements:
*
* - input must fit into 32 bits
*
* _Available since v3.1._
*/
function toInt32(int256 value) internal pure returns (int32) {
require(
value >= type(int32).min && value <= type(int32).max,
"SafeCast: value doesn't fit in 32 bits"
);
return int32(value);
}
/**
* @dev Returns the downcasted int16 from int256, reverting on
* overflow (when the input is less than smallest int16 or
* greater than largest int16).
*
* Counterpart to Solidity's `int16` operator.
*
* Requirements:
*
* - input must fit into 16 bits
*
* _Available since v3.1._
*/
function toInt16(int256 value) internal pure returns (int16) {
require(
value >= type(int16).min && value <= type(int16).max,
"SafeCast: value doesn't fit in 16 bits"
);
return int16(value);
}
/**
* @dev Returns the downcasted int8 from int256, reverting on
* overflow (when the input is less than smallest int8 or
* greater than largest int8).
*
* Counterpart to Solidity's `int8` operator.
*
* Requirements:
*
* - input must fit into 8 bits.
*
* _Available since v3.1._
*/
function toInt8(int256 value) internal pure returns (int8) {
require(
value >= type(int8).min && value <= type(int8).max,
"SafeCast: value doesn't fit in 8 bits"
);
return int8(value);
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
*
* Requirements:
*
* - input must be less than or equal to maxInt256.
*/
function toInt256(uint256 value) internal pure returns (int256) {
// Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive
require(
value <= uint256(type(int256).max),
"SafeCast: value doesn't fit in an int256"
);
return int256(value);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "./IERC20.sol";
import "./draft-IERC20Permit.sol";
import "./Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(
IERC20 token,
address spender,
uint256 value
) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @dev String operations.
*/
library Strings {
bytes16 private constant _HEX_SYMBOLS = "0123456789abcdef";
/**
* @dev Converts a `uint256` to its ASCII `string` decimal representation.
*/
function toString(uint256 value) internal pure returns (string memory) {
// Inspired by OraclizeAPI's implementation - MIT licence
// https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.sol
if (value == 0) {
return "0";
}
uint256 temp = value;
uint256 digits;
while (temp != 0) {
digits++;
temp /= 10;
}
bytes memory buffer = new bytes(digits);
while (value != 0) {
digits -= 1;
buffer[digits] = bytes1(uint8(48 + uint256(value % 10)));
value /= 10;
}
return string(buffer);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/
function toHexString(uint256 value) internal pure returns (string memory) {
if (value == 0) {
return "0x00";
}
uint256 temp = value;
uint256 length = 0;
while (temp != 0) {
length++;
temp >>= 8;
}
return toHexString(value, length);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/
function toHexString(uint256 value, uint256 length)
internal
pure
returns (string memory)
{
bytes memory buffer = new bytes(2 * length + 2);
buffer[0] = "0";
buffer[1] = "x";
for (uint256 i = 2 * length + 1; i > 1; --i) {
buffer[i] = _HEX_SYMBOLS[value & 0xf];
value >>= 4;
}
require(value == 0, "Strings: hex length insufficient");
return string(buffer);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}// SPDX-License-Identifier: MIT
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;
import "../dependencies/openzeppelin/contracts/IERC20.sol";
interface IAutoCompoundApe is IERC20 {
/**
* @dev Emitted during deposit()
* @param user The address of the user deposit for
* @param amountDeposited The amount being deposit
* @param amountShare The share being deposit
**/
event Deposit(
address indexed caller,
address indexed user,
uint256 amountDeposited,
uint256 amountShare
);
/**
* @dev Emitted during withdraw()
* @param user The address of the user
* @param amountWithdraw The amount being withdraw
* @param amountShare The share being withdraw
**/
event Redeem(
address indexed user,
uint256 amountWithdraw,
uint256 amountShare
);
/**
* @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
);
/**
* @notice deposit an `amount` of ape into compound pool.
* @param onBehalf The address of user will receive the pool share
* @param amount The amount of ape to be deposit
**/
function deposit(address onBehalf, uint256 amount) external;
/**
* @notice withdraw an `amount` of ape from compound pool.
* @param amount The amount of ape to be withdraw
**/
function withdraw(uint256 amount) external;
/**
* @notice collect ape reward in ApeCoinStaking and deposit to earn compound interest.
**/
function harvestAndCompound() external;
}// SPDX-License-Identifier: agpl-3.0
pragma solidity ^0.8.0;
import "../dependencies/openzeppelin/contracts/IERC20.sol";
interface ICApe is IERC20 {
/**
* @return the amount of shares that corresponds to `amount` protocol-controlled Ape.
*/
function getShareByPooledApe(uint256 amount)
external
view
returns (uint256);
/**
* @return the amount of Ape that corresponds to `sharesAmount` token shares.
*/
function getPooledApeByShares(uint256 sharesAmount)
external
view
returns (uint256);
/**
* @return the amount of shares belongs to _account.
*/
function sharesOf(address _account) external view returns (uint256);
}// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.0;
import {IRewardController} from "./IRewardController.sol";
import {IPool} from "./IPool.sol";
/**
* @title IInitializablePToken
*
* @notice Interface for the initialize function on PToken
**/
interface IInitializablePToken {
/**
* @dev Emitted when an pToken is initialized
* @param underlyingAsset The address of the underlying asset
* @param pool The address of the associated pool
* @param treasury The address of the treasury
* @param incentivesController The address of the incentives controller for this pToken
* @param pTokenDecimals The decimals of the underlying
* @param pTokenName The name of the pToken
* @param pTokenSymbol The symbol of the pToken
* @param params A set of encoded parameters for additional initialization
**/
event Initialized(
address indexed underlyingAsset,
address indexed pool,
address treasury,
address incentivesController,
uint8 pTokenDecimals,
string pTokenName,
string pTokenSymbol,
bytes params
);
/**
* @notice Initializes the pToken
* @param pool The pool contract that is initializing this contract
* @param treasury The address of the ParaSpace treasury, receiving the fees on this pToken
* @param underlyingAsset The address of the underlying asset of this pToken (E.g. WETH for pWETH)
* @param incentivesController The smart contract managing potential incentives distribution
* @param pTokenDecimals The decimals of the pToken, same as the underlying asset's
* @param pTokenName The name of the pToken
* @param pTokenSymbol The symbol of the pToken
* @param params A set of encoded parameters for additional initialization
*/
function initialize(
IPool pool,
address treasury,
address underlyingAsset,
IRewardController incentivesController,
uint8 pTokenDecimals,
string calldata pTokenName,
string calldata pTokenSymbol,
bytes calldata params
) external;
}// SPDX-License-Identifier: AGPL-3.0
pragma solidity ^0.8.0;
import {IERC20} from "../dependencies/openzeppelin/contracts/IERC20.sol";
import {IScaledBalanceToken} from "./IScaledBalanceToken.sol";
import {IInitializablePToken} from "./IInitializablePToken.sol";
import {IXTokenType} from "./IXTokenType.sol";
import {DataTypes} from "../protocol/libraries/types/DataTypes.sol";
/**
* @title IPToken
*
* @notice Defines the basic interface for an PToken.
**/
interface IPToken is
IERC20,
IScaledBalanceToken,
IInitializablePToken,
IXTokenType
{
/**
* @notice Mints `amount` xTokens to `user`
* @param caller The address performing the mint
* @param onBehalfOf The address of the user that will receive the minted xTokens
* @param amount The amount of tokens getting minted
* @param index The next liquidity index of the reserve
* @return `true` if the the previous balance of the user was 0
*/
function mint(
address caller,
address onBehalfOf,
uint256 amount,
uint256 index
) external returns (bool);
/**
* @notice Burns xTokens 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 xTokens will be burned
* @param receiverOfUnderlying The address that will receive the underlying
* @param amount The amount being burned
* @param index The next liquidity index of the reserve
**/
function burn(
address from,
address receiverOfUnderlying,
uint256 amount,
uint256 index,
DataTypes.TimeLockParams calldata timeLockParams
) external;
/**
* @notice Mints xTokens to the reserve treasury
* @param amount The amount of tokens getting minted
* @param index The next liquidity index of the reserve
*/
function mintToTreasury(uint256 amount, uint256 index) external;
/**
* @notice Transfers xTokens in the event of a borrow being liquidated, in case the liquidators reclaims the xToken
* @param from The address getting liquidated, current owner of the xTokens
* @param to The recipient
* @param value The amount of tokens getting transferred
**/
function transferOnLiquidation(
address from,
address to,
uint256 value
) 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 amount The amount getting transferred
**/
function transferUnderlyingTo(
address user,
uint256 amount,
DataTypes.TimeLockParams calldata timeLockParams
) external;
/**
* @notice Handles the underlying received by the xToken after the transfer has been completed.
* @dev The default implementation is empty as with standard ERC20 tokens, nothing needs to be done after the
* transfer is concluded. However in the future there may be xTokens that allow for example to stake the underlying
* to receive LM rewards. In that case, `handleRepayment()` would perform the staking of the underlying asset.
* @param user The user executing the repayment
* @param amount The amount getting repaid
**/
function handleRepayment(address user, uint256 amount) external;
/**
* @notice Allow passing a signed message to approve spending
* @dev implements the permit function as for
* https://github.com/ethereum/EIPs/blob/8a34d644aacf0f9f8f00815307fd7dd5da07655f/EIPS/eip-2612.md
* @param owner The owner of the funds
* @param spender The spender
* @param value The amount
* @param deadline The deadline timestamp, type(uint256).max for max deadline
* @param v Signature param
* @param s Signature param
* @param r Signature param
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @notice Returns the address of the underlying asset of this xToken (E.g. WETH for pWETH)
* @return The address of the underlying asset
**/
function UNDERLYING_ASSET_ADDRESS() external view returns (address);
/**
* @notice Returns the address of the ParaSpace treasury, receiving the fees on this xToken.
* @return Address of the ParaSpace treasury
**/
function RESERVE_TREASURY_ADDRESS() external view returns (address);
/**
* @notice Get the domain separator for the token
* @dev Return cached value if chainId matches cache, otherwise recomputes separator
* @return The domain separator of the token at current chain
*/
function DOMAIN_SEPARATOR() external view returns (bytes32);
/**
* @notice Returns the nonce for owner.
* @param owner The address of the owner
* @return The nonce of the owner
**/
function nonces(address owner) external view returns (uint256);
/**
* @notice Rescue and transfer tokens locked in this contract
* @param token The address of the token
* @param to The address of the recipient
* @param amount The amount of token to transfer
*/
function rescueTokens(
address token,
address to,
uint256 amount
) external;
function claimUnderlying(
address timeLockV1,
address cApeV1,
address cApeV2,
address apeCoin,
uint256[] calldata agreementIds
) external 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: AGPL-3.0
pragma solidity ^0.8.0;
/**
* @title IScaledBalanceToken
*
* @notice Defines the basic interface for a scaledbalance token.
**/
interface IScaledBalanceToken {
/**
* @dev Emitted after the mint action
* @param caller The address performing the mint
* @param onBehalfOf The address of the user that will receive the minted scaled balance tokens
* @param value The amount being minted (user entered amount + balance increase from interest)
* @param balanceIncrease The increase in balance since the last action of the user
* @param index The next liquidity index of the reserve
**/
event Mint(
address indexed caller,
address indexed onBehalfOf,
uint256 value,
uint256 balanceIncrease,
uint256 index
);
/**
* @dev Emitted after scaled balance tokens are burned
* @param from The address from which the scaled tokens will be burned
* @param target The address that will receive the underlying, if any
* @param value The amount being burned (user entered amount - balance increase from interest)
* @param balanceIncrease The increase in balance since the last action of the user
* @param index The next liquidity index of the reserve
**/
event Burn(
address indexed from,
address indexed target,
uint256 value,
uint256 balanceIncrease,
uint256 index
);
/**
* @notice Returns the scaled balance of the user.
* @dev The scaled balance is the sum of all the updated stored balance divided by the reserve's liquidity index
* at the moment of the update
* @param user The user whose balance is calculated
* @return The scaled balance of the user
**/
function scaledBalanceOf(address user) external view returns (uint256);
/**
* @notice Returns the scaled balance of the user and the scaled total supply.
* @param user The address of the user
* @return The scaled balance of the user
* @return The scaled total supply
**/
function getScaledUserBalanceAndSupply(address user)
external
view
returns (uint256, uint256);
/**
* @notice Returns the scaled total supply of the scaled balance token. Represents sum(debt/index)
* @return The scaled total supply
**/
function scaledTotalSupply() external view returns (uint256);
/**
* @notice Returns last index interest was accrued to the user's balance
* @param user The address of the user
* @return The last index interest was accrued to the user's balance, expressed in ray
**/
function getPreviousIndex(address user) 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;
/**
* @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;
/**
* @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;
/**
* @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: agpl-3.0
pragma solidity ^0.8.0;
/**
* @title EIP712Base
*
* @notice Base contract implementation of EIP712.
*/
abstract contract EIP712Base {
bytes public constant EIP712_REVISION = bytes("1");
bytes32 internal constant EIP712_DOMAIN =
keccak256(
"EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"
);
// Map of address nonces (address => nonce)
mapping(address => uint256) internal _nonces;
bytes32 internal _domainSeparator;
uint256 internal immutable _chainId;
/**
* @dev Constructor.
*/
constructor() {
_chainId = block.chainid;
}
/**
* @notice Get the domain separator for the token
* @dev Return cached value if chainId matches cache, otherwise recomputes separator
* @return The domain separator of the token at current chain
*/
function DOMAIN_SEPARATOR() public view virtual returns (bytes32) {
if (block.chainid == _chainId) {
return _domainSeparator;
}
return _calculateDomainSeparator();
}
/**
* @notice Returns the nonce value for address specified as parameter
* @param owner The address for which the nonce is being returned
* @return The nonce value for the input address`
*/
function nonces(address owner) public view virtual returns (uint256) {
return _nonces[owner];
}
/**
* @notice Compute the current domain separator
* @return The domain separator for the token
*/
function _calculateDomainSeparator() internal view returns (bytes32) {
return
keccak256(
abi.encode(
EIP712_DOMAIN,
keccak256(bytes(_EIP712BaseId())),
keccak256(EIP712_REVISION),
block.chainid,
address(this)
)
);
}
/**
* @notice Returns the user readable name of signing domain (e.g. token name)
* @return The name of the signing domain
*/
function _EIP712BaseId() internal view virtual returns (string memory);
}// SPDX-License-Identifier: BUSL-1.1
pragma solidity ^0.8.0;
import {Context} from "../../../dependencies/openzeppelin/contracts/Context.sol";
import {IERC20} from "../../../dependencies/openzeppelin/contracts/IERC20.sol";
import {IERC20Detailed} from "../../../dependencies/openzeppelin/contracts/IERC20Detailed.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";
/**
* @title IncentivizedERC20
* , inspired by the Openzeppelin ERC20 implementation
* @notice Basic ERC20 implementation
**/
abstract contract IncentivizedERC20 is Context, IERC20Detailed {
using WadRayMath for uint256;
using SafeCast for uint256;
/**
* @dev Only pool admin can call functions marked by this modifier.
**/
modifier onlyPoolAdmin() {
IACLManager aclManager = IACLManager(
_addressesProvider.getACLManager()
);
require(
aclManager.isPoolAdmin(msg.sender),
Errors.CALLER_NOT_POOL_ADMIN
);
_;
}
/**
* @dev Only pool can call functions marked by this modifier.
**/
modifier onlyPool() {
require(_msgSender() == address(POOL), Errors.CALLER_MUST_BE_POOL);
_;
}
/**
* @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.
*/
struct UserState {
uint128 balance;
uint128 additionalData;
}
// Map of users address and their state data (userAddress => userStateData)
mapping(address => UserState) internal _userState;
// Map of allowances (delegator => delegatee => allowanceAmount)
mapping(address => mapping(address => uint256)) private _allowances;
uint256 internal _totalSupply;
string private _name;
string private _symbol;
uint8 private _decimals;
IRewardController internal _rewardController;
IPoolAddressesProvider internal immutable _addressesProvider;
IPool public immutable POOL;
/**
* @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
* @param decimals_ The number of decimals of the token
*/
constructor(
IPool pool,
string memory name_,
string memory symbol_,
uint8 decimals_
) {
_addressesProvider = pool.ADDRESSES_PROVIDER();
_name = name_;
_symbol = symbol_;
_decimals = decimals_;
POOL = pool;
}
/// @inheritdoc IERC20Detailed
function name() public view override returns (string memory) {
return _name;
}
/// @inheritdoc IERC20Detailed
function symbol() external view override returns (string memory) {
return _symbol;
}
/// @inheritdoc IERC20Detailed
function decimals() external view override returns (uint8) {
return _decimals;
}
/// @inheritdoc IERC20
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
/// @inheritdoc IERC20
function balanceOf(address account)
public
view
virtual
override
returns (uint256)
{
return _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 _rewardController;
}
/**
* @notice Sets a new Incentives Controller
* @param controller the new Incentives controller
**/
function setIncentivesController(IRewardController controller)
external
onlyPoolAdmin
{
_rewardController = controller;
}
/// @inheritdoc IERC20
function transfer(address recipient, uint256 amount)
external
virtual
override
returns (bool)
{
uint128 castAmount = amount.toUint128();
_transfer(_msgSender(), recipient, castAmount);
return true;
}
/// @inheritdoc IERC20
function allowance(address owner, address spender)
external
view
virtual
override
returns (uint256)
{
return _allowances[owner][spender];
}
/// @inheritdoc IERC20
function approve(address spender, uint256 amount)
external
virtual
override
returns (bool)
{
_approve(_msgSender(), spender, amount);
return true;
}
/// @inheritdoc IERC20
function transferFrom(
address sender,
address recipient,
uint256 amount
) external virtual override returns (bool) {
uint128 castAmount = amount.toUint128();
_approve(
sender,
_msgSender(),
_allowances[sender][_msgSender()] - castAmount
);
_transfer(sender, recipient, castAmount);
return true;
}
/**
* @notice Increases the allowance of spender to spend _msgSender() tokens
* @param spender The user allowed to spend on behalf of _msgSender()
* @param addedValue The amount being added to the allowance
* @return `true`
**/
function increaseAllowance(address spender, uint256 addedValue)
external
virtual
returns (bool)
{
_approve(
_msgSender(),
spender,
_allowances[_msgSender()][spender] + addedValue
);
return true;
}
/**
* @notice Decreases the allowance of spender to spend _msgSender() tokens
* @param spender The user allowed to spend on behalf of _msgSender()
* @param subtractedValue The amount being subtracted to the allowance
* @return `true`
**/
function decreaseAllowance(address spender, uint256 subtractedValue)
external
virtual
returns (bool)
{
_approve(
_msgSender(),
spender,
_allowances[_msgSender()][spender] - subtractedValue
);
return true;
}
/**
* @notice Transfers tokens between two users and apply incentives if defined.
* @param sender The source address
* @param recipient The destination address
* @param amount The amount getting transferred
*/
function _transfer(
address sender,
address recipient,
uint128 amount
) internal virtual {
uint128 oldSenderBalance = _userState[sender].balance;
_userState[sender].balance = oldSenderBalance - amount;
uint128 oldRecipientBalance = _userState[recipient].balance;
_userState[recipient].balance = oldRecipientBalance + amount;
IRewardController rewardControllerLocal = _rewardController;
if (address(rewardControllerLocal) != address(0)) {
uint256 currentTotalSupply = _totalSupply;
rewardControllerLocal.handleAction(
sender,
currentTotalSupply,
oldSenderBalance
);
if (sender != recipient) {
rewardControllerLocal.handleAction(
recipient,
currentTotalSupply,
oldRecipientBalance
);
}
}
}
/**
* @notice Approve `spender` to use `amount` of `owner`s balance
* @param owner The address owning the tokens
* @param spender The address approved for spending
* @param amount The amount of tokens to approve spending of
*/
function _approve(
address owner,
address spender,
uint256 amount
) internal virtual {
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @notice Update the name of the token
* @param newName The new name for the token
*/
function _setName(string memory newName) internal {
_name = newName;
}
/**
* @notice Update the symbol for the token
* @param newSymbol The new symbol for the token
*/
function _setSymbol(string memory newSymbol) internal {
_symbol = newSymbol;
}
/**
* @notice Update the number of decimals for the token
* @param newDecimals The new number of decimals for the token
*/
function _setDecimals(uint8 newDecimals) internal {
_decimals = newDecimals;
}
}// SPDX-License-Identifier: agpl-3.0
pragma solidity ^0.8.0;
import {IRewardController} from "../../../interfaces/IRewardController.sol";
import {IPool} from "../../../interfaces/IPool.sol";
import {IncentivizedERC20} from "./IncentivizedERC20.sol";
/**
* @title MintableIncentivizedERC20
*
* @notice Implements mint and burn functions for IncentivizedERC20
**/
abstract contract MintableIncentivizedERC20 is IncentivizedERC20 {
/**
* @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
* @param decimals The number of decimals of the token
*/
constructor(
IPool pool,
string memory name,
string memory symbol,
uint8 decimals
) IncentivizedERC20(pool, name, symbol, decimals) {
// Intentionally left blank
}
/**
* @notice Mints tokens to an account and apply incentives if defined
* @param account The address receiving tokens
* @param amount The amount of tokens to mint
*/
function _mint(address account, uint128 amount) internal virtual {
uint256 oldTotalSupply = _totalSupply;
_totalSupply = oldTotalSupply + amount;
uint128 oldAccountBalance = _userState[account].balance;
_userState[account].balance = oldAccountBalance + amount;
IRewardController rewardControllerLocal = _rewardController;
if (address(rewardControllerLocal) != address(0)) {
rewardControllerLocal.handleAction(
account,
oldTotalSupply,
oldAccountBalance
);
}
}
/**
* @notice Burns tokens from an account and apply incentives if defined
* @param account The account whose tokens are burnt
* @param amount The amount of tokens to burn
*/
function _burn(address account, uint128 amount) internal virtual {
uint256 oldTotalSupply = _totalSupply;
_totalSupply = oldTotalSupply - amount;
uint128 oldAccountBalance = _userState[account].balance;
_userState[account].balance = oldAccountBalance - amount;
IRewardController rewardControllerLocal = _rewardController;
if (address(rewardControllerLocal) != address(0)) {
rewardControllerLocal.handleAction(
account,
oldTotalSupply,
oldAccountBalance
);
}
}
}// SPDX-License-Identifier: agpl-3.0
pragma solidity ^0.8.0;
import {SafeCast} from "../../../dependencies/openzeppelin/contracts/SafeCast.sol";
import {Errors} from "../../libraries/helpers/Errors.sol";
import {WadRayMath} from "../../libraries/math/WadRayMath.sol";
import {IPool} from "../../../interfaces/IPool.sol";
import {IScaledBalanceToken} from "../../../interfaces/IScaledBalanceToken.sol";
import {MintableIncentivizedERC20} from "./MintableIncentivizedERC20.sol";
/**
* @title ScaledBalanceTokenBase
*
* @notice Basic ERC20 implementation of scaled balance token
**/
abstract contract ScaledBalanceTokenBaseERC20 is
MintableIncentivizedERC20,
IScaledBalanceToken
{
using WadRayMath for uint256;
using SafeCast for uint256;
/**
* @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
* @param decimals The number of decimals of the token
*/
constructor(
IPool pool,
string memory name,
string memory symbol,
uint8 decimals
) MintableIncentivizedERC20(pool, name, symbol, decimals) {
// Intentionally left blank
}
/// @inheritdoc IScaledBalanceToken
function scaledBalanceOf(address user)
public
view
virtual
override
returns (uint256)
{
return super.balanceOf(user);
}
/// @inheritdoc IScaledBalanceToken
function getScaledUserBalanceAndSupply(address user)
external
view
virtual
override
returns (uint256, uint256)
{
return (super.balanceOf(user), super.totalSupply());
}
/// @inheritdoc IScaledBalanceToken
function scaledTotalSupply()
public
view
virtual
override
returns (uint256)
{
return super.totalSupply();
}
/// @inheritdoc IScaledBalanceToken
function getPreviousIndex(address user)
external
view
virtual
override
returns (uint256)
{
return _userState[user].additionalData;
}
/**
* @notice Implements the basic logic to mint a scaled balance token.
* @param caller The address performing the mint
* @param onBehalfOf The address of the user that will receive the scaled tokens
* @param amount The amount of tokens getting minted
* @param index The next liquidity index of the reserve
* @return `true` if the the previous balance of the user was 0
**/
function _mintScaled(
address caller,
address onBehalfOf,
uint256 amount,
uint256 index
) internal virtual returns (bool) {
uint256 amountScaled = amount.rayDiv(index);
require(amountScaled != 0, Errors.INVALID_MINT_AMOUNT);
uint256 scaledBalance = super.balanceOf(onBehalfOf);
uint256 balanceIncrease = scaledBalance.rayMul(index) -
scaledBalance.rayMul(_userState[onBehalfOf].additionalData);
_userState[onBehalfOf].additionalData = index.toUint128();
_mint(onBehalfOf, amountScaled.toUint128());
uint256 amountToMint = amount + balanceIncrease;
emit Transfer(address(0), onBehalfOf, amountToMint);
emit Mint(caller, onBehalfOf, amountToMint, balanceIncrease, index);
return (scaledBalance == 0);
}
/**
* @notice Implements the basic logic to burn a scaled balance token.
* @dev In some instances, a burn transaction will emit a mint event
* if the amount to burn is less than the interest that the user accrued
* @param user The user which debt is burnt
* @param target The address that will receive the underlying, if any
* @param amount The amount getting burned
* @param index The variable debt index of the reserve
**/
function _burnScaled(
address user,
address target,
uint256 amount,
uint256 index
) internal virtual {
uint256 amountScaled = amount.rayDiv(index);
require(amountScaled != 0, Errors.INVALID_BURN_AMOUNT);
uint256 scaledBalance = super.balanceOf(user);
uint256 balanceIncrease = scaledBalance.rayMul(index) -
scaledBalance.rayMul(_userState[user].additionalData);
_userState[user].additionalData = index.toUint128();
_burn(user, amountScaled.toUint128());
if (balanceIncrease > amount) {
uint256 amountToMint = balanceIncrease - amount;
emit Transfer(address(0), user, amountToMint);
emit Mint(user, user, amountToMint, balanceIncrease, index);
} else {
uint256 amountToBurn = amount - balanceIncrease;
emit Transfer(user, address(0), amountToBurn);
emit Burn(user, target, amountToBurn, balanceIncrease, index);
}
}
function _transferScaled(
address from,
address to,
uint256 amount,
uint256 index
) internal virtual {
super._transfer(from, to, amount.rayDiv(index).toUint128());
}
}{
"remappings": [
"contracts/=contracts/",
"ds-test/=lib/ds-test/src/",
"forge-std/=lib/forge-std/src/",
"pnm-contracts/=lib/pnm-contracts/"
],
"optimizer": {
"enabled": true,
"runs": 200
},
"metadata": {
"bytecodeHash": "ipfs"
},
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"devdoc",
"userdoc",
"metadata",
"abi"
]
}
},
"evmVersion": "london",
"libraries": {}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"contract IPool","name":"pool","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"target","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"balanceIncrease","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"index","type":"uint256"}],"name":"Burn","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":"treasury","type":"address"},{"indexed":false,"internalType":"address","name":"incentivesController","type":"address"},{"indexed":false,"internalType":"uint8","name":"pTokenDecimals","type":"uint8"},{"indexed":false,"internalType":"string","name":"pTokenName","type":"string"},{"indexed":false,"internalType":"string","name":"pTokenSymbol","type":"string"},{"indexed":false,"internalType":"bytes","name":"params","type":"bytes"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"caller","type":"address"},{"indexed":true,"internalType":"address","name":"onBehalfOf","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"balanceIncrease","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"index","type":"uint256"}],"name":"Mint","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[],"name":"DOMAIN_SEPARATOR","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"EIP712_REVISION","outputs":[{"internalType":"bytes","name":"","type":"bytes"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"PERMIT_TYPEHASH","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"POOL","outputs":[{"internalType":"contract IPool","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"PTOKEN_REVISION","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RESERVE_TREASURY_ADDRESS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"UNDERLYING_ASSET_ADDRESS","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"receiverOfUnderlying","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"uint256","name":"index","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":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"timeLockV1","type":"address"},{"internalType":"address","name":"cApeV1","type":"address"},{"internalType":"address","name":"cApeV2","type":"address"},{"internalType":"address","name":"apeCoin","type":"address"},{"internalType":"uint256[]","name":"agreementIds","type":"uint256[]"}],"name":"claimUnderlying","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"subtractedValue","type":"uint256"}],"name":"decreaseAllowance","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"getIncentivesController","outputs":[{"internalType":"contract IRewardController","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"getPreviousIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"getScaledUserBalanceAndSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"},{"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":"address","name":"user","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"handleRepayment","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"addedValue","type":"uint256"}],"name":"increaseAllowance","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"contract IPool","name":"initializingPool","type":"address"},{"internalType":"address","name":"treasury","type":"address"},{"internalType":"address","name":"underlyingAsset","type":"address"},{"internalType":"contract IRewardController","name":"incentivesController","type":"address"},{"internalType":"uint8","name":"pTokenDecimals","type":"uint8"},{"internalType":"string","name":"pTokenName","type":"string"},{"internalType":"string","name":"pTokenSymbol","type":"string"},{"internalType":"bytes","name":"params","type":"bytes"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"caller","type":"address"},{"internalType":"address","name":"onBehalfOf","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"uint256","name":"index","type":"uint256"}],"name":"mint","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"amount","type":"uint256"},{"internalType":"uint256","name":"index","type":"uint256"}],"name":"mintToTreasury","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"nonces","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"},{"internalType":"uint256","name":"deadline","type":"uint256"},{"internalType":"uint8","name":"v","type":"uint8"},{"internalType":"bytes32","name":"r","type":"bytes32"},{"internalType":"bytes32","name":"s","type":"bytes32"}],"name":"permit","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":"rescueTokens","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"user","type":"address"}],"name":"scaledBalanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"scaledTotalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"contract IRewardController","name":"controller","type":"address"}],"name":"setIncentivesController","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"symbol","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":"recipient","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"address","name":"recipient","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"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":"amount","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"}]Contract Creation Code
60e0604052600080553480156200001557600080fd5b50604051620034b9380380620034b9833981016040819052620000389162000169565b806040518060400160405280600b81526020016a141513d2d15397d253541360aa1b8152506040518060400160405280600b81526020016a141513d2d15397d253541360aa1b81525060008383838383838383836001600160a01b0316630542975c6040518163ffffffff1660e01b8152600401602060405180830381865afa158015620000ca573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620000f0919062000169565b6001600160a01b031660805260376200010a848262000235565b50603862000119838262000235565b506039805460ff191660ff9290921691909117905550506001600160a01b031660a05250504660c052506200030195505050505050565b6001600160a01b03811681146200016657600080fd5b50565b6000602082840312156200017c57600080fd5b8151620001898162000150565b9392505050565b634e487b7160e01b600052604160045260246000fd5b600181811c90821680620001bb57607f821691505b602082108103620001dc57634e487b7160e01b600052602260045260246000fd5b50919050565b601f8211156200023057600081815260208120601f850160051c810160208610156200020b5750805b601f850160051c820191505b818110156200022c5782815560010162000217565b5050505b505050565b81516001600160401b0381111562000251576200025162000190565b6200026981620002628454620001a6565b84620001e2565b602080601f831160018114620002a15760008415620002885750858301515b600019600386901b1c1916600185901b1785556200022c565b600085815260208120601f198616915b82811015620002d257888601518255948401946001909101908401620002b1565b5085821015620002f15787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b60805160a05160c051613111620003a86000396000611d7e01526000818161038301528181610671015281816107910152818161092801528181610a9b01528181610f1901528181610f7e01528181611125015281816111a60152818161135c015281816113f40152818161144a015281816114b80152818161159101528181611b190152818161223701526123250152600081816115f101526119b001526131116000f3fe608060405234801561001057600080fd5b506004361061021c5760003560e01c80637df5bd3b11610125578063b1bf962d116100ad578063dd62ed3e1161007c578063dd62ed3e146104cc578063e075398614610505578063e655dbd81461053e578063f866c31914610551578063fb42a9a31461056457600080fd5b8063b1bf962d1461048b578063b3f1c93d14610493578063cea9d26f146104a6578063d505accf146104b957600080fd5b8063a457c2d7116100f4578063a457c2d714610434578063a6627c8b14610447578063a9059cbb14610456578063ae16733514610469578063b16a19de1461047a57600080fd5b80637df5bd3b146103f35780637ecebe001461040657806388dd91a11461041957806395d89b411461042c57600080fd5b80633644e515116101a85780635444edf7116101775780635444edf71461035857806370a082311461036b5780637535d2461461037e57806375d26413146103bd57806378160376146103d357600080fd5b80633644e51514610317578063395093511461031f57806340e23fe1146103325780634f2c268f1461034557600080fd5b8063183fb413116101ef578063183fb413146102a05780631da24f3e146102b557806323b872dd146102c857806330adf81f146102db578063313ce5671461030257600080fd5b806306fdde0314610221578063095ea7b31461023f5780630afbcdc91461026257806318160ddd1461028a575b600080fd5b61022961056c565b60405161023691906127d5565b60405180910390f35b61025261024d366004612817565b6105fe565b6040519015158152602001610236565b610275610270366004612843565b610615565b60408051928352602083019190915201610236565b61029261062d565b604051908152602001610236565b6102b36102ae3660046128ba565b6106e9565b005b6102926102c3366004612843565b6109c1565b6102526102d63660046129ae565b6109cc565b6102927f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c981565b60395460405160ff9091168152602001610236565b610292610a36565b61025261032d366004612817565b610a45565b6102926103403660046129ef565b610a7c565b6102b3610353366004612ac0565b610efd565b6102b3610366366004612aff565b611109565b610292610379366004612843565b611333565b6103a57f000000000000000000000000000000000000000000000000000000000000000081565b6040516001600160a01b039091168152602001610236565b60395461010090046001600160a01b03166103a5565b610229604051806040016040528060018152602001603160f81b81525081565b6102b3610401366004612b5b565b6113d8565b610292610414366004612843565b61147e565b6102b3610427366004612817565b61149c565b6102296114fe565b610252610442366004612817565b61150d565b60066040516102369190612b93565b610252610464366004612817565b611544565b603c546001600160a01b03166103a5565b603d546001600160a01b03166103a5565b610292611567565b6102526104a1366004612bad565b611572565b6102b36104b43660046129ae565b6115ed565b6102b36104c7366004612bf3565b611778565b6102926104da366004612c61565b6001600160a01b03918216600090815260356020908152604080832093909416825291909152205490565b610292610513366004612843565b6001600160a01b0316600090815260346020526040902054600160801b90046001600160801b031690565b6102b361054c366004612843565b6119ac565b6102b361055f3660046129ae565b611afd565b610292609581565b60606037805461057b90612c9a565b80601f01602080910402602001604051908101604052809291908181526020018280546105a790612c9a565b80156105f45780601f106105c9576101008083540402835291602001916105f4565b820191906000526020600020905b8154815290600101906020018083116105d757829003601f168201915b5050505050905090565b600061060b338484611b6d565b5060015b92915050565b60008061062183611bce565b60365491509150915091565b60008061063960365490565b90508060000361064b57600091505090565b603d5460405163d15e005360e01b81526001600160a01b0391821660048201526106e3917f0000000000000000000000000000000000000000000000000000000000000000169063d15e005390602401602060405180830381865afa1580156106b8573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106dc9190612cce565b8290611bf2565b91505090565b60015460959060ff16806106fc5750303b155b80610708575060005481115b6107705760405162461bcd60e51b815260206004820152602e60248201527f436f6e747261637420696e7374616e63652068617320616c726561647920626560448201526d195b881a5b9a5d1a585b1a5e995960921b60648201526084015b60405180910390fd5b60015460ff1615801561078f576001805460ff19168117905560008290555b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168d6001600160a01b03161460405180604001604052806002815260200161383760f01b815250906107fd5760405162461bcd60e51b815260040161076791906127d5565b5061083d88888080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250611c3692505050565b61087c86868080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250611c4292505050565b6039805460ff191660ff8b16179055604080518082019091526002815261373760f01b60208201526001600160a01b038c166108cb5760405162461bcd60e51b815260040161076791906127d5565b50603c80546001600160a01b03808f166001600160a01b031992831617909255603d80548e8416921691909117905560398054918c1661010002610100600160a81b0319909216919091179055610920611c4e565b603b819055507f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168b6001600160a01b03167fb19e051f8af41150ccccb3fc2c2d8d15f4a4cf434f32a559ba75fe73d6eea20b8e8d8d8d8d8d8d8d8d60405161099999989796959493929190612d10565b60405180910390a380156109b2576001805460ff191690555b50505050505050505050505050565b600061060f82611bce565b6000806109d883611cf7565b6001600160a01b038616600090815260356020908152604080832033808552925290912054919250610a2091879190610a1b906001600160801b03861690612d94565b611b6d565b610a2b858583611d64565b506001949350505050565b6000610a40611d7a565b905090565b3360008181526035602090815260408083206001600160a01b0387168452909152812054909161060b918590610a1b908690612da7565b604080518082019091526002815261323360f01b6020820152600090337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031614610ae15760405162461bcd60e51b815260040161076791906127d5565b50603d546001600160a01b039081169086168114600081610b69576040516370a0823160e01b81523060048201526001600160a01b038416906370a0823190602401602060405180830381865afa158015610b40573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610b649190612cce565b610bd1565b6040516370a0823160e01b81523060048201526001600160a01b038a16906370a0823190602401602060405180830381865afa158015610bad573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610bd19190612cce565b604051630d74982760e31b81529091506001600160a01b038b1690636ba4c13890610c029089908990600401612dba565b600060405180830381600087803b158015610c1c57600080fd5b505af1158015610c30573d6000803e3d6000fd5b5050505081610cb7576040516370a0823160e01b815230600482015281906001600160a01b038516906370a0823190602401602060405180830381865afa158015610c7f573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ca39190612cce565b610cad9190612d94565b9350505050610ef3565b6040516370a0823160e01b815230600482015260009082906001600160a01b038c16906370a0823190602401602060405180830381865afa158015610d00573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d249190612cce565b610d2e9190612d94565b905080600003610d45576000945050505050610ef3565b604051632e1a7d4d60e01b8152600481018290526001600160a01b038b1690632e1a7d4d90602401600060405180830381600087803b158015610d8757600080fd5b505af1158015610d9b573d6000803e3d6000fd5b5050604051636eb1769f60e11b81523060048201526001600160a01b038c811660248301528b16925063dd62ed3e9150604401602060405180830381865afa158015610deb573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610e0f9190612cce565b600003610e8c5760405163095ea7b360e01b81526001600160a01b038a81166004830152600019602483015289169063095ea7b3906044016020604051808303816000875af1158015610e66573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610e8a9190612df3565b505b6040516311f9fbc960e21b8152306004820152602481018290526001600160a01b038a16906347e7ef2490604401600060405180830381600087803b158015610ed457600080fd5b505af1158015610ee8573d6000803e3d6000fd5b509296505050505050505b9695505050505050565b604080518082019091526002815261323360f01b6020820152337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031614610f5f5760405162461bcd60e51b815260040161076791906127d5565b50610f6d6020820182612e15565b65ffffffffffff16156110ed5760007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa158015610fda573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ffe9190612e3d565b6040805160018082528183019092529192506000919060208083019080368337019050509050838160008151811061103857611038612e70565b602002602001018181525050816001600160a01b031663df03349460008560200160208101906110689190612e86565b603d546001600160a01b0316858a61108360208b018b612e15565b6040518763ffffffff1660e01b81526004016110a496959493929190612eb7565b6020604051808303816000875af11580156110c3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906110e79190612cce565b50909350505b603d54611104906001600160a01b03168484611db2565b505050565b604080518082019091526002815261323360f01b6020820152337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03161461116b5760405162461bcd60e51b815260040161076791906127d5565b5061117885858585611e3d565b6001600160a01b038416301461132c576111956020820182612e15565b65ffffffffffff16156113155760007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa158015611202573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906112269190612e3d565b6040805160018082528183019092529192506000919060208083019080368337019050509050848160008151811061126057611260612e70565b602002602001018181525050816001600160a01b031663df03349460008560200160208101906112909190612e86565b603d546001600160a01b0316858b6112ab60208b018b612e15565b6040518763ffffffff1660e01b81526004016112cc96959493929190612eb7565b6020604051808303816000875af11580156112eb573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061130f9190612cce565b50909450505b603d5461132c906001600160a01b03168585611db2565b5050505050565b603d5460405163d15e005360e01b81526001600160a01b03918216600482015260009161060f917f00000000000000000000000000000000000000000000000000000000000000009091169063d15e005390602401602060405180830381865afa1580156113a5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906113c99190612cce565b6113d284611bce565b90611bf2565b604080518082019091526002815261323360f01b6020820152337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03161461143a5760405162461bcd60e51b815260040161076791906127d5565b50811561147a57603c54611104907f0000000000000000000000000000000000000000000000000000000000000000906001600160a01b03168484612078565b5050565b6001600160a01b0381166000908152603a602052604081205461060f565b604080518082019091526002815261323360f01b6020820152337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316146111045760405162461bcd60e51b815260040161076791906127d5565b60606038805461057b90612c9a565b3360008181526035602090815260408083206001600160a01b0387168452909152812054909161060b918590610a1b908690612d94565b60008061155083611cf7565b905061155d338583611d64565b5060019392505050565b6000610a4060365490565b604080518082019091526002815261323360f01b6020820152600090337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316146115d75760405162461bcd60e51b815260040161076791906127d5565b506115e485858585612078565b95945050505050565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663707cd7166040518163ffffffff1660e01b8152600401602060405180830381865afa15801561164d573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116719190612e3d565b604051637be53ca160e01b81523360048201529091506001600160a01b03821690637be53ca190602401602060405180830381865afa1580156116b8573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116dc9190612df3565b604051806040016040528060018152602001603160f81b815250906117145760405162461bcd60e51b815260040161076791906127d5565b50603d54604080518082019091526002815261383560f01b6020820152906001600160a01b0386811691160361175d5760405162461bcd60e51b815260040161076791906127d5565b506117726001600160a01b0385168484611db2565b50505050565b604080518082019091526002815261373760f01b60208201526001600160a01b0388166117b85760405162461bcd60e51b815260040161076791906127d5565b50834211156040518060400160405280600281526020016106e760f31b815250906117f65760405162461bcd60e51b815260040161076791906127d5565b506001600160a01b0387166000908152603a602052604081205490611819610a36565b604080517f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c960208201526001600160a01b03808d1692820192909252908a1660608201526080810189905260a0810184905260c0810188905260e001604051602081830303815290604052805190602001206040516020016118b292919061190160f01b81526002810192909252602282015260420190565b60408051601f1981840301815282825280516020918201206000845290830180835281905260ff8816918301919091526060820186905260808201859052915060019060a0016020604051602081039080840390855afa15801561191a573d6000803e3d6000fd5b505050602060405103516001600160a01b0316896001600160a01b03161460405180604001604052806002815260200161373960f01b815250906119715760405162461bcd60e51b815260040161076791906127d5565b5061197d826001612da7565b6001600160a01b038a166000908152603a60205260409020556119a1898989611b6d565b505050505050505050565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663707cd7166040518163ffffffff1660e01b8152600401602060405180830381865afa158015611a0c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611a309190612e3d565b604051637be53ca160e01b81523360048201529091506001600160a01b03821690637be53ca190602401602060405180830381865afa158015611a77573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611a9b9190612df3565b604051806040016040528060018152602001603160f81b81525090611ad35760405162461bcd60e51b815260040161076791906127d5565b5050603980546001600160a01b0390921661010002610100600160a81b0319909216919091179055565b604080518082019091526002815261323360f01b6020820152337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031614611b5f5760405162461bcd60e51b815260040161076791906127d5565b50611104838383600061220f565b6001600160a01b0383811660008181526035602090815260408083209487168084529482529182902085905590518481527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910160405180910390a3505050565b6001600160a01b03166000908152603460205260409020546001600160801b031690565b600081156b019d971e4fe8401e740000001983900484111517611c1457600080fd5b506b033b2e3c9fd0803ce800000091026b019d971e4fe8401e74000000010490565b603761147a8282612f8a565b603861147a8282612f8a565b60007f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f611c796123b5565b805160209182012060408051808201825260018152603160f81b90840152805192830193909352918101919091527fc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc660608201524660808201523060a082015260c00160405160208183030381529060405280519060200120905090565b60006001600160801b03821115611d605760405162461bcd60e51b815260206004820152602760248201527f53616665436173743a2076616c756520646f65736e27742066697420696e20316044820152663238206269747360c81b6064820152608401610767565b5090565b6111048383836001600160801b0316600161220f565b60007f00000000000000000000000000000000000000000000000000000000000000004603611daa5750603b5490565b610a40611c4e565b60405163a9059cbb60e01b8082526001600160a01b0384166004830152602482018390529060008060448382895af1611def573d6000803e3d6000fd5b50611df9846123bf565b6117725760405162461bcd60e51b815260206004820152601560248201527423a83b191d103330b4b632b2103a3930b739b332b960591b6044820152606401610767565b6000611e498383612467565b604080518082019091526002815261323560f01b602082015290915081611e835760405162461bcd60e51b815260040161076791906127d5565b506000611e8f86611bce565b6001600160a01b03871660009081526034602052604081205491925090611ec7908390600160801b90046001600160801b0316611bf2565b611ed18386611bf2565b611edb9190612d94565b9050611ee684611cf7565b6001600160a01b038816600090815260346020526040902080546001600160801b03928316600160801b029216919091179055611f2b87611f2685611cf7565b6124a6565b84811115611fd1576000611f3f8683612d94565b9050876001600160a01b031660006001600160a01b03166000805160206130bc83398151915283604051611f7591815260200190565b60405180910390a360408051828152602081018490529081018690526001600160a01b0389169081907f458f5fa412d0f69b08dd84872b0215675cc67bc1d5b6fd93300a1c3878b861969060600160405180910390a35061206f565b6000611fdd8287612d94565b905060006001600160a01b0316886001600160a01b03166000805160206130bc8339815191528360405161201391815260200190565b60405180910390a360408051828152602081018490529081018690526001600160a01b0380891691908a16907f4cf25bc1d991c17529c25213d3cc0cda295eeaad5f13f361969b12ea48015f90906060015b60405180910390a3505b50505050505050565b6000806120858484612467565b6040805180820190915260028152610c8d60f21b6020820152909150816120bf5760405162461bcd60e51b815260040161076791906127d5565b5060006120cb86611bce565b6001600160a01b03871660009081526034602052604081205491925090612103908390600160801b90046001600160801b0316611bf2565b61210d8387611bf2565b6121179190612d94565b905061212285611cf7565b6001600160a01b038816600090815260346020526040902080546001600160801b03928316600160801b0292169190911790556121678761216285611cf7565b612590565b60006121738288612da7565b9050876001600160a01b031660006001600160a01b03166000805160206130bc833981519152836040516121a991815260200190565b60405180910390a360408051828152602081018490529081018790526001600160a01b03808a1691908b16907f458f5fa412d0f69b08dd84872b0215675cc67bc1d5b6fd93300a1c3878b861969060600160405180910390a35050159695505050505050565b603d5460405163d15e005360e01b81526001600160a01b0391821660048201819052916000917f00000000000000000000000000000000000000000000000000000000000000009091169063d15e005390602401602060405180830381865afa158015612280573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906122a49190612cce565b905060006122b5826113d289611bce565b905060006122c6836113d289611bce565b90506122d4888888866125d5565b84156123825760405163d59544cb60e01b81526001600160a01b03858116600483015289811660248301528881166044830152600060648301526084820188905260a4820184905260c482018390527f0000000000000000000000000000000000000000000000000000000000000000169063d59544cb9060e401600060405180830381600087803b15801561236957600080fd5b505af115801561237d573d6000803e3d6000fd5b505050505b866001600160a01b0316886001600160a01b03166000805160206130bc8339815191528860405161206591815260200190565b6060610a4061056c565b60006123e4565b62461bcd60e51b600052602060045280602452508060445260646000fd5b3d801561242357602081146124545761241e7f475076323a206d616c666f726d6564207472616e7366657220726573756c7400601f6123c6565b612461565b823b61244b5761244b7311d41d8c8e881b9bdd08184818dbdb9d1c9858dd60621b60146123c6565b60019150612461565b3d6000803e600051151591505b50919050565b600081156b033b2e3c9fd0803ce80000006002840419048411171561248b57600080fd5b506b033b2e3c9fd0803ce80000009190910260028204010490565b6036546124bc6001600160801b03831682612d94565b6036556001600160a01b0383166000908152603460205260409020546001600160801b03166124eb838261304a565b6001600160a01b03858116600090815260346020526040902080546001600160801b0319166001600160801b039390931692909217909155603954610100900416801561132c576040516318c39f1760e11b81526001600160a01b038216906331873e2e9061256290889087908790600401613071565b600060405180830381600087803b15801561257c57600080fd5b505af11580156119a1573d6000803e3d6000fd5b6036546125a66001600160801b03831682612da7565b6036556001600160a01b0383166000908152603460205260409020546001600160801b03166124eb838261309b565b61177284846125ec6125e78686612467565b611cf7565b6001600160a01b0383166000908152603460205260409020546001600160801b0316612618828261304a565b6001600160a01b0385811660009081526034602052604080822080546001600160801b0319166001600160801b03958616179055918616815220541661265e838261309b565b6001600160a01b03858116600090815260346020526040902080546001600160801b0319166001600160801b0393909316929092179091556039546101009004168015612787576036546040516318c39f1760e11b81526001600160a01b038316906331873e2e906126d8908a9085908990600401613071565b600060405180830381600087803b1580156126f257600080fd5b505af1158015612706573d6000803e3d6000fd5b50505050856001600160a01b0316876001600160a01b03161461206f576040516318c39f1760e11b81526001600160a01b038316906331873e2e9061275390899085908890600401613071565b600060405180830381600087803b15801561276d57600080fd5b505af1158015612781573d6000803e3d6000fd5b50505050505b505050505050565b6000815180845260005b818110156127b557602081850181015186830182015201612799565b506000602082860101526020601f19601f83011685010191505092915050565b6020815260006127e8602083018461278f565b9392505050565b6001600160a01b038116811461280457600080fd5b50565b8035612812816127ef565b919050565b6000806040838503121561282a57600080fd5b8235612835816127ef565b946020939093013593505050565b60006020828403121561285557600080fd5b81356127e8816127ef565b803560ff8116811461281257600080fd5b60008083601f84011261288357600080fd5b50813567ffffffffffffffff81111561289b57600080fd5b6020830191508360208285010111156128b357600080fd5b9250929050565b60008060008060008060008060008060006101008c8e0312156128dc57600080fd5b6128e58c612807565b9a506128f360208d01612807565b995061290160408d01612807565b985061290f60608d01612807565b975061291d60808d01612860565b965067ffffffffffffffff8060a08e0135111561293957600080fd5b6129498e60a08f01358f01612871565b909750955060c08d013581101561295f57600080fd5b61296f8e60c08f01358f01612871565b909550935060e08d013581101561298557600080fd5b506129968d60e08e01358e01612871565b81935080925050509295989b509295989b9093969950565b6000806000606084860312156129c357600080fd5b83356129ce816127ef565b925060208401356129de816127ef565b929592945050506040919091013590565b60008060008060008060a08789031215612a0857600080fd5b8635612a13816127ef565b95506020870135612a23816127ef565b94506040870135612a33816127ef565b93506060870135612a43816127ef565b9250608087013567ffffffffffffffff80821115612a6057600080fd5b818901915089601f830112612a7457600080fd5b813581811115612a8357600080fd5b8a60208260051b8501011115612a9857600080fd5b6020830194508093505050509295509295509295565b60006040828403121561246157600080fd5b600080600060808486031215612ad557600080fd5b8335612ae0816127ef565b925060208401359150612af68560408601612aae565b90509250925092565b600080600080600060c08688031215612b1757600080fd5b8535612b22816127ef565b94506020860135612b32816127ef565b93506040860135925060608601359150612b4f8760808801612aae565b90509295509295909350565b60008060408385031215612b6e57600080fd5b50508035926020909101359150565b634e487b7160e01b600052602160045260246000fd5b60208101601d8310612ba757612ba7612b7d565b91905290565b60008060008060808587031215612bc357600080fd5b8435612bce816127ef565b93506020850135612bde816127ef565b93969395505050506040820135916060013590565b600080600080600080600060e0888a031215612c0e57600080fd5b8735612c19816127ef565b96506020880135612c29816127ef565b95506040880135945060608801359350612c4560808901612860565b925060a0880135915060c0880135905092959891949750929550565b60008060408385031215612c7457600080fd5b8235612c7f816127ef565b91506020830135612c8f816127ef565b809150509250929050565b600181811c90821680612cae57607f821691505b60208210810361246157634e487b7160e01b600052602260045260246000fd5b600060208284031215612ce057600080fd5b5051919050565b81835281816020850137506000828201602090810191909152601f909101601f19169091010190565b6001600160a01b038a811682528916602082015260ff8816604082015260c060608201819052600090612d46908301888a612ce7565b8281036080840152612d59818789612ce7565b905082810360a0840152612d6e818587612ce7565b9c9b505050505050505050505050565b634e487b7160e01b600052601160045260246000fd5b8181038181111561060f5761060f612d7e565b8082018082111561060f5761060f612d7e565b6020808252810182905260006001600160fb1b03831115612dda57600080fd5b8260051b80856040850137919091016040019392505050565b600060208284031215612e0557600080fd5b815180151581146127e857600080fd5b600060208284031215612e2757600080fd5b813565ffffffffffff811681146127e857600080fd5b600060208284031215612e4f57600080fd5b81516127e8816127ef565b634e487b7160e01b600052604160045260246000fd5b634e487b7160e01b600052603260045260246000fd5b600060208284031215612e9857600080fd5b8135600281106127e857600080fd5b6002811061280457612804612b7d565b600060c08201612ec689612ea7565b8883526020612ed489612ea7565b8381018990526001600160a01b03888116604086015260c060608601528751928390528782019260e086019060005b81811015612f1f57855183529484019491840191600101612f03565b50509616608085015250505065ffffffffffff9190911660a090910152949350505050565b601f82111561110457600081815260208120601f850160051c81016020861015612f6b5750805b601f850160051c820191505b8181101561278757828155600101612f77565b815167ffffffffffffffff811115612fa457612fa4612e5a565b612fb881612fb28454612c9a565b84612f44565b602080601f831160018114612fed5760008415612fd55750858301515b600019600386901b1c1916600185901b178555612787565b600085815260208120601f198616915b8281101561301c57888601518255948401946001909101908401612ffd565b508582101561303a5787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6001600160801b0382811682821603908082111561306a5761306a612d7e565b5092915050565b6001600160a01b0393909316835260208301919091526001600160801b0316604082015260600190565b6001600160801b0381811683821601908082111561306a5761306a612d7e56feddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa264697066735822122057140aad28500af04ed970922fee7684b83e86bd25004dc73b26b00d6c9ea80d64736f6c634300081100330000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff
Deployed Bytecode
0x608060405234801561001057600080fd5b506004361061021c5760003560e01c80637df5bd3b11610125578063b1bf962d116100ad578063dd62ed3e1161007c578063dd62ed3e146104cc578063e075398614610505578063e655dbd81461053e578063f866c31914610551578063fb42a9a31461056457600080fd5b8063b1bf962d1461048b578063b3f1c93d14610493578063cea9d26f146104a6578063d505accf146104b957600080fd5b8063a457c2d7116100f4578063a457c2d714610434578063a6627c8b14610447578063a9059cbb14610456578063ae16733514610469578063b16a19de1461047a57600080fd5b80637df5bd3b146103f35780637ecebe001461040657806388dd91a11461041957806395d89b411461042c57600080fd5b80633644e515116101a85780635444edf7116101775780635444edf71461035857806370a082311461036b5780637535d2461461037e57806375d26413146103bd57806378160376146103d357600080fd5b80633644e51514610317578063395093511461031f57806340e23fe1146103325780634f2c268f1461034557600080fd5b8063183fb413116101ef578063183fb413146102a05780631da24f3e146102b557806323b872dd146102c857806330adf81f146102db578063313ce5671461030257600080fd5b806306fdde0314610221578063095ea7b31461023f5780630afbcdc91461026257806318160ddd1461028a575b600080fd5b61022961056c565b60405161023691906127d5565b60405180910390f35b61025261024d366004612817565b6105fe565b6040519015158152602001610236565b610275610270366004612843565b610615565b60408051928352602083019190915201610236565b61029261062d565b604051908152602001610236565b6102b36102ae3660046128ba565b6106e9565b005b6102926102c3366004612843565b6109c1565b6102526102d63660046129ae565b6109cc565b6102927f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c981565b60395460405160ff9091168152602001610236565b610292610a36565b61025261032d366004612817565b610a45565b6102926103403660046129ef565b610a7c565b6102b3610353366004612ac0565b610efd565b6102b3610366366004612aff565b611109565b610292610379366004612843565b611333565b6103a57f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff81565b6040516001600160a01b039091168152602001610236565b60395461010090046001600160a01b03166103a5565b610229604051806040016040528060018152602001603160f81b81525081565b6102b3610401366004612b5b565b6113d8565b610292610414366004612843565b61147e565b6102b3610427366004612817565b61149c565b6102296114fe565b610252610442366004612817565b61150d565b60066040516102369190612b93565b610252610464366004612817565b611544565b603c546001600160a01b03166103a5565b603d546001600160a01b03166103a5565b610292611567565b6102526104a1366004612bad565b611572565b6102b36104b43660046129ae565b6115ed565b6102b36104c7366004612bf3565b611778565b6102926104da366004612c61565b6001600160a01b03918216600090815260356020908152604080832093909416825291909152205490565b610292610513366004612843565b6001600160a01b0316600090815260346020526040902054600160801b90046001600160801b031690565b6102b361054c366004612843565b6119ac565b6102b361055f3660046129ae565b611afd565b610292609581565b60606037805461057b90612c9a565b80601f01602080910402602001604051908101604052809291908181526020018280546105a790612c9a565b80156105f45780601f106105c9576101008083540402835291602001916105f4565b820191906000526020600020905b8154815290600101906020018083116105d757829003601f168201915b5050505050905090565b600061060b338484611b6d565b5060015b92915050565b60008061062183611bce565b60365491509150915091565b60008061063960365490565b90508060000361064b57600091505090565b603d5460405163d15e005360e01b81526001600160a01b0391821660048201526106e3917f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff169063d15e005390602401602060405180830381865afa1580156106b8573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106dc9190612cce565b8290611bf2565b91505090565b60015460959060ff16806106fc5750303b155b80610708575060005481115b6107705760405162461bcd60e51b815260206004820152602e60248201527f436f6e747261637420696e7374616e63652068617320616c726561647920626560448201526d195b881a5b9a5d1a585b1a5e995960921b60648201526084015b60405180910390fd5b60015460ff1615801561078f576001805460ff19168117905560008290555b7f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b03168d6001600160a01b03161460405180604001604052806002815260200161383760f01b815250906107fd5760405162461bcd60e51b815260040161076791906127d5565b5061083d88888080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250611c3692505050565b61087c86868080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250611c4292505050565b6039805460ff191660ff8b16179055604080518082019091526002815261373760f01b60208201526001600160a01b038c166108cb5760405162461bcd60e51b815260040161076791906127d5565b50603c80546001600160a01b03808f166001600160a01b031992831617909255603d80548e8416921691909117905560398054918c1661010002610100600160a81b0319909216919091179055610920611c4e565b603b819055507f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b03168b6001600160a01b03167fb19e051f8af41150ccccb3fc2c2d8d15f4a4cf434f32a559ba75fe73d6eea20b8e8d8d8d8d8d8d8d8d60405161099999989796959493929190612d10565b60405180910390a380156109b2576001805460ff191690555b50505050505050505050505050565b600061060f82611bce565b6000806109d883611cf7565b6001600160a01b038616600090815260356020908152604080832033808552925290912054919250610a2091879190610a1b906001600160801b03861690612d94565b611b6d565b610a2b858583611d64565b506001949350505050565b6000610a40611d7a565b905090565b3360008181526035602090815260408083206001600160a01b0387168452909152812054909161060b918590610a1b908690612da7565b604080518082019091526002815261323360f01b6020820152600090337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031614610ae15760405162461bcd60e51b815260040161076791906127d5565b50603d546001600160a01b039081169086168114600081610b69576040516370a0823160e01b81523060048201526001600160a01b038416906370a0823190602401602060405180830381865afa158015610b40573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610b649190612cce565b610bd1565b6040516370a0823160e01b81523060048201526001600160a01b038a16906370a0823190602401602060405180830381865afa158015610bad573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610bd19190612cce565b604051630d74982760e31b81529091506001600160a01b038b1690636ba4c13890610c029089908990600401612dba565b600060405180830381600087803b158015610c1c57600080fd5b505af1158015610c30573d6000803e3d6000fd5b5050505081610cb7576040516370a0823160e01b815230600482015281906001600160a01b038516906370a0823190602401602060405180830381865afa158015610c7f573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ca39190612cce565b610cad9190612d94565b9350505050610ef3565b6040516370a0823160e01b815230600482015260009082906001600160a01b038c16906370a0823190602401602060405180830381865afa158015610d00573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610d249190612cce565b610d2e9190612d94565b905080600003610d45576000945050505050610ef3565b604051632e1a7d4d60e01b8152600481018290526001600160a01b038b1690632e1a7d4d90602401600060405180830381600087803b158015610d8757600080fd5b505af1158015610d9b573d6000803e3d6000fd5b5050604051636eb1769f60e11b81523060048201526001600160a01b038c811660248301528b16925063dd62ed3e9150604401602060405180830381865afa158015610deb573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610e0f9190612cce565b600003610e8c5760405163095ea7b360e01b81526001600160a01b038a81166004830152600019602483015289169063095ea7b3906044016020604051808303816000875af1158015610e66573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610e8a9190612df3565b505b6040516311f9fbc960e21b8152306004820152602481018290526001600160a01b038a16906347e7ef2490604401600060405180830381600087803b158015610ed457600080fd5b505af1158015610ee8573d6000803e3d6000fd5b509296505050505050505b9695505050505050565b604080518082019091526002815261323360f01b6020820152337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031614610f5f5760405162461bcd60e51b815260040161076791906127d5565b50610f6d6020820182612e15565b65ffffffffffff16156110ed5760007f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa158015610fda573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ffe9190612e3d565b6040805160018082528183019092529192506000919060208083019080368337019050509050838160008151811061103857611038612e70565b602002602001018181525050816001600160a01b031663df03349460008560200160208101906110689190612e86565b603d546001600160a01b0316858a61108360208b018b612e15565b6040518763ffffffff1660e01b81526004016110a496959493929190612eb7565b6020604051808303816000875af11580156110c3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906110e79190612cce565b50909350505b603d54611104906001600160a01b03168484611db2565b505050565b604080518082019091526002815261323360f01b6020820152337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b03161461116b5760405162461bcd60e51b815260040161076791906127d5565b5061117885858585611e3d565b6001600160a01b038416301461132c576111956020820182612e15565b65ffffffffffff16156113155760007f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031663e0a09c686040518163ffffffff1660e01b8152600401602060405180830381865afa158015611202573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906112269190612e3d565b6040805160018082528183019092529192506000919060208083019080368337019050509050848160008151811061126057611260612e70565b602002602001018181525050816001600160a01b031663df03349460008560200160208101906112909190612e86565b603d546001600160a01b0316858b6112ab60208b018b612e15565b6040518763ffffffff1660e01b81526004016112cc96959493929190612eb7565b6020604051808303816000875af11580156112eb573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061130f9190612cce565b50909450505b603d5461132c906001600160a01b03168585611db2565b5050505050565b603d5460405163d15e005360e01b81526001600160a01b03918216600482015260009161060f917f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff9091169063d15e005390602401602060405180830381865afa1580156113a5573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906113c99190612cce565b6113d284611bce565b90611bf2565b604080518082019091526002815261323360f01b6020820152337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b03161461143a5760405162461bcd60e51b815260040161076791906127d5565b50811561147a57603c54611104907f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff906001600160a01b03168484612078565b5050565b6001600160a01b0381166000908152603a602052604081205461060f565b604080518082019091526002815261323360f01b6020820152337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b0316146111045760405162461bcd60e51b815260040161076791906127d5565b60606038805461057b90612c9a565b3360008181526035602090815260408083206001600160a01b0387168452909152812054909161060b918590610a1b908690612d94565b60008061155083611cf7565b905061155d338583611d64565b5060019392505050565b6000610a4060365490565b604080518082019091526002815261323360f01b6020820152600090337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b0316146115d75760405162461bcd60e51b815260040161076791906127d5565b506115e485858585612078565b95945050505050565b60007f000000000000000000000000fae470a311f61944346bbb8709cdc2398506be466001600160a01b031663707cd7166040518163ffffffff1660e01b8152600401602060405180830381865afa15801561164d573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116719190612e3d565b604051637be53ca160e01b81523360048201529091506001600160a01b03821690637be53ca190602401602060405180830381865afa1580156116b8573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906116dc9190612df3565b604051806040016040528060018152602001603160f81b815250906117145760405162461bcd60e51b815260040161076791906127d5565b50603d54604080518082019091526002815261383560f01b6020820152906001600160a01b0386811691160361175d5760405162461bcd60e51b815260040161076791906127d5565b506117726001600160a01b0385168484611db2565b50505050565b604080518082019091526002815261373760f01b60208201526001600160a01b0388166117b85760405162461bcd60e51b815260040161076791906127d5565b50834211156040518060400160405280600281526020016106e760f31b815250906117f65760405162461bcd60e51b815260040161076791906127d5565b506001600160a01b0387166000908152603a602052604081205490611819610a36565b604080517f6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c960208201526001600160a01b03808d1692820192909252908a1660608201526080810189905260a0810184905260c0810188905260e001604051602081830303815290604052805190602001206040516020016118b292919061190160f01b81526002810192909252602282015260420190565b60408051601f1981840301815282825280516020918201206000845290830180835281905260ff8816918301919091526060820186905260808201859052915060019060a0016020604051602081039080840390855afa15801561191a573d6000803e3d6000fd5b505050602060405103516001600160a01b0316896001600160a01b03161460405180604001604052806002815260200161373960f01b815250906119715760405162461bcd60e51b815260040161076791906127d5565b5061197d826001612da7565b6001600160a01b038a166000908152603a60205260409020556119a1898989611b6d565b505050505050505050565b60007f000000000000000000000000fae470a311f61944346bbb8709cdc2398506be466001600160a01b031663707cd7166040518163ffffffff1660e01b8152600401602060405180830381865afa158015611a0c573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611a309190612e3d565b604051637be53ca160e01b81523360048201529091506001600160a01b03821690637be53ca190602401602060405180830381865afa158015611a77573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611a9b9190612df3565b604051806040016040528060018152602001603160f81b81525090611ad35760405162461bcd60e51b815260040161076791906127d5565b5050603980546001600160a01b0390921661010002610100600160a81b0319909216919091179055565b604080518082019091526002815261323360f01b6020820152337f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff6001600160a01b031614611b5f5760405162461bcd60e51b815260040161076791906127d5565b50611104838383600061220f565b6001600160a01b0383811660008181526035602090815260408083209487168084529482529182902085905590518481527f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925910160405180910390a3505050565b6001600160a01b03166000908152603460205260409020546001600160801b031690565b600081156b019d971e4fe8401e740000001983900484111517611c1457600080fd5b506b033b2e3c9fd0803ce800000091026b019d971e4fe8401e74000000010490565b603761147a8282612f8a565b603861147a8282612f8a565b60007f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f611c796123b5565b805160209182012060408051808201825260018152603160f81b90840152805192830193909352918101919091527fc89efdaa54c0f20c7adf612882df0950f5a951637e0307cdcb4c672f298b8bc660608201524660808201523060a082015260c00160405160208183030381529060405280519060200120905090565b60006001600160801b03821115611d605760405162461bcd60e51b815260206004820152602760248201527f53616665436173743a2076616c756520646f65736e27742066697420696e20316044820152663238206269747360c81b6064820152608401610767565b5090565b6111048383836001600160801b0316600161220f565b60007f00000000000000000000000000000000000000000000000000000000000000014603611daa5750603b5490565b610a40611c4e565b60405163a9059cbb60e01b8082526001600160a01b0384166004830152602482018390529060008060448382895af1611def573d6000803e3d6000fd5b50611df9846123bf565b6117725760405162461bcd60e51b815260206004820152601560248201527423a83b191d103330b4b632b2103a3930b739b332b960591b6044820152606401610767565b6000611e498383612467565b604080518082019091526002815261323560f01b602082015290915081611e835760405162461bcd60e51b815260040161076791906127d5565b506000611e8f86611bce565b6001600160a01b03871660009081526034602052604081205491925090611ec7908390600160801b90046001600160801b0316611bf2565b611ed18386611bf2565b611edb9190612d94565b9050611ee684611cf7565b6001600160a01b038816600090815260346020526040902080546001600160801b03928316600160801b029216919091179055611f2b87611f2685611cf7565b6124a6565b84811115611fd1576000611f3f8683612d94565b9050876001600160a01b031660006001600160a01b03166000805160206130bc83398151915283604051611f7591815260200190565b60405180910390a360408051828152602081018490529081018690526001600160a01b0389169081907f458f5fa412d0f69b08dd84872b0215675cc67bc1d5b6fd93300a1c3878b861969060600160405180910390a35061206f565b6000611fdd8287612d94565b905060006001600160a01b0316886001600160a01b03166000805160206130bc8339815191528360405161201391815260200190565b60405180910390a360408051828152602081018490529081018690526001600160a01b0380891691908a16907f4cf25bc1d991c17529c25213d3cc0cda295eeaad5f13f361969b12ea48015f90906060015b60405180910390a3505b50505050505050565b6000806120858484612467565b6040805180820190915260028152610c8d60f21b6020820152909150816120bf5760405162461bcd60e51b815260040161076791906127d5565b5060006120cb86611bce565b6001600160a01b03871660009081526034602052604081205491925090612103908390600160801b90046001600160801b0316611bf2565b61210d8387611bf2565b6121179190612d94565b905061212285611cf7565b6001600160a01b038816600090815260346020526040902080546001600160801b03928316600160801b0292169190911790556121678761216285611cf7565b612590565b60006121738288612da7565b9050876001600160a01b031660006001600160a01b03166000805160206130bc833981519152836040516121a991815260200190565b60405180910390a360408051828152602081018490529081018790526001600160a01b03808a1691908b16907f458f5fa412d0f69b08dd84872b0215675cc67bc1d5b6fd93300a1c3878b861969060600160405180910390a35050159695505050505050565b603d5460405163d15e005360e01b81526001600160a01b0391821660048201819052916000917f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff9091169063d15e005390602401602060405180830381865afa158015612280573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906122a49190612cce565b905060006122b5826113d289611bce565b905060006122c6836113d289611bce565b90506122d4888888866125d5565b84156123825760405163d59544cb60e01b81526001600160a01b03858116600483015289811660248301528881166044830152600060648301526084820188905260a4820184905260c482018390527f0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff169063d59544cb9060e401600060405180830381600087803b15801561236957600080fd5b505af115801561237d573d6000803e3d6000fd5b505050505b866001600160a01b0316886001600160a01b03166000805160206130bc8339815191528860405161206591815260200190565b6060610a4061056c565b60006123e4565b62461bcd60e51b600052602060045280602452508060445260646000fd5b3d801561242357602081146124545761241e7f475076323a206d616c666f726d6564207472616e7366657220726573756c7400601f6123c6565b612461565b823b61244b5761244b7311d41d8c8e881b9bdd08184818dbdb9d1c9858dd60621b60146123c6565b60019150612461565b3d6000803e600051151591505b50919050565b600081156b033b2e3c9fd0803ce80000006002840419048411171561248b57600080fd5b506b033b2e3c9fd0803ce80000009190910260028204010490565b6036546124bc6001600160801b03831682612d94565b6036556001600160a01b0383166000908152603460205260409020546001600160801b03166124eb838261304a565b6001600160a01b03858116600090815260346020526040902080546001600160801b0319166001600160801b039390931692909217909155603954610100900416801561132c576040516318c39f1760e11b81526001600160a01b038216906331873e2e9061256290889087908790600401613071565b600060405180830381600087803b15801561257c57600080fd5b505af11580156119a1573d6000803e3d6000fd5b6036546125a66001600160801b03831682612da7565b6036556001600160a01b0383166000908152603460205260409020546001600160801b03166124eb838261309b565b61177284846125ec6125e78686612467565b611cf7565b6001600160a01b0383166000908152603460205260409020546001600160801b0316612618828261304a565b6001600160a01b0385811660009081526034602052604080822080546001600160801b0319166001600160801b03958616179055918616815220541661265e838261309b565b6001600160a01b03858116600090815260346020526040902080546001600160801b0319166001600160801b0393909316929092179091556039546101009004168015612787576036546040516318c39f1760e11b81526001600160a01b038316906331873e2e906126d8908a9085908990600401613071565b600060405180830381600087803b1580156126f257600080fd5b505af1158015612706573d6000803e3d6000fd5b50505050856001600160a01b0316876001600160a01b03161461206f576040516318c39f1760e11b81526001600160a01b038316906331873e2e9061275390899085908890600401613071565b600060405180830381600087803b15801561276d57600080fd5b505af1158015612781573d6000803e3d6000fd5b50505050505b505050505050565b6000815180845260005b818110156127b557602081850181015186830182015201612799565b506000602082860101526020601f19601f83011685010191505092915050565b6020815260006127e8602083018461278f565b9392505050565b6001600160a01b038116811461280457600080fd5b50565b8035612812816127ef565b919050565b6000806040838503121561282a57600080fd5b8235612835816127ef565b946020939093013593505050565b60006020828403121561285557600080fd5b81356127e8816127ef565b803560ff8116811461281257600080fd5b60008083601f84011261288357600080fd5b50813567ffffffffffffffff81111561289b57600080fd5b6020830191508360208285010111156128b357600080fd5b9250929050565b60008060008060008060008060008060006101008c8e0312156128dc57600080fd5b6128e58c612807565b9a506128f360208d01612807565b995061290160408d01612807565b985061290f60608d01612807565b975061291d60808d01612860565b965067ffffffffffffffff8060a08e0135111561293957600080fd5b6129498e60a08f01358f01612871565b909750955060c08d013581101561295f57600080fd5b61296f8e60c08f01358f01612871565b909550935060e08d013581101561298557600080fd5b506129968d60e08e01358e01612871565b81935080925050509295989b509295989b9093969950565b6000806000606084860312156129c357600080fd5b83356129ce816127ef565b925060208401356129de816127ef565b929592945050506040919091013590565b60008060008060008060a08789031215612a0857600080fd5b8635612a13816127ef565b95506020870135612a23816127ef565b94506040870135612a33816127ef565b93506060870135612a43816127ef565b9250608087013567ffffffffffffffff80821115612a6057600080fd5b818901915089601f830112612a7457600080fd5b813581811115612a8357600080fd5b8a60208260051b8501011115612a9857600080fd5b6020830194508093505050509295509295509295565b60006040828403121561246157600080fd5b600080600060808486031215612ad557600080fd5b8335612ae0816127ef565b925060208401359150612af68560408601612aae565b90509250925092565b600080600080600060c08688031215612b1757600080fd5b8535612b22816127ef565b94506020860135612b32816127ef565b93506040860135925060608601359150612b4f8760808801612aae565b90509295509295909350565b60008060408385031215612b6e57600080fd5b50508035926020909101359150565b634e487b7160e01b600052602160045260246000fd5b60208101601d8310612ba757612ba7612b7d565b91905290565b60008060008060808587031215612bc357600080fd5b8435612bce816127ef565b93506020850135612bde816127ef565b93969395505050506040820135916060013590565b600080600080600080600060e0888a031215612c0e57600080fd5b8735612c19816127ef565b96506020880135612c29816127ef565b95506040880135945060608801359350612c4560808901612860565b925060a0880135915060c0880135905092959891949750929550565b60008060408385031215612c7457600080fd5b8235612c7f816127ef565b91506020830135612c8f816127ef565b809150509250929050565b600181811c90821680612cae57607f821691505b60208210810361246157634e487b7160e01b600052602260045260246000fd5b600060208284031215612ce057600080fd5b5051919050565b81835281816020850137506000828201602090810191909152601f909101601f19169091010190565b6001600160a01b038a811682528916602082015260ff8816604082015260c060608201819052600090612d46908301888a612ce7565b8281036080840152612d59818789612ce7565b905082810360a0840152612d6e818587612ce7565b9c9b505050505050505050505050565b634e487b7160e01b600052601160045260246000fd5b8181038181111561060f5761060f612d7e565b8082018082111561060f5761060f612d7e565b6020808252810182905260006001600160fb1b03831115612dda57600080fd5b8260051b80856040850137919091016040019392505050565b600060208284031215612e0557600080fd5b815180151581146127e857600080fd5b600060208284031215612e2757600080fd5b813565ffffffffffff811681146127e857600080fd5b600060208284031215612e4f57600080fd5b81516127e8816127ef565b634e487b7160e01b600052604160045260246000fd5b634e487b7160e01b600052603260045260246000fd5b600060208284031215612e9857600080fd5b8135600281106127e857600080fd5b6002811061280457612804612b7d565b600060c08201612ec689612ea7565b8883526020612ed489612ea7565b8381018990526001600160a01b03888116604086015260c060608601528751928390528782019260e086019060005b81811015612f1f57855183529484019491840191600101612f03565b50509616608085015250505065ffffffffffff9190911660a090910152949350505050565b601f82111561110457600081815260208120601f850160051c81016020861015612f6b5750805b601f850160051c820191505b8181101561278757828155600101612f77565b815167ffffffffffffffff811115612fa457612fa4612e5a565b612fb881612fb28454612c9a565b84612f44565b602080601f831160018114612fed5760008415612fd55750858301515b600019600386901b1c1916600185901b178555612787565b600085815260208120601f198616915b8281101561301c57888601518255948401946001909101908401612ffd565b508582101561303a5787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6001600160801b0382811682821603908082111561306a5761306a612d7e565b5092915050565b6001600160a01b0393909316835260208301919091526001600160801b0316604082015260600190565b6001600160801b0381811683821601908082111561306a5761306a612d7e56feddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa264697066735822122057140aad28500af04ed970922fee7684b83e86bd25004dc73b26b00d6c9ea80d64736f6c63430008110033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff
-----Decoded View---------------
Arg [0] : pool (address): 0x6d596FdFD3381eBB5eCd526eBcAec8cC2BA019fF
-----Encoded View---------------
1 Constructor Arguments found :
Arg [0] : 0000000000000000000000006d596fdfd3381ebb5ecd526ebcaec8cc2ba019ff
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.