// SPDX-License-Identifier: MITpragmasolidity >=0.6.2 <0.8.0;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @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
* ====
*/functionisContract(address account) internalviewreturns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in// construction, since the code is only stored at the end of the// constructor execution.uint256 size;
// solhint-disable-next-line no-inline-assemblyassembly { size :=extcodesize(account) }
return size >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].
*/functionsendValue(addresspayable recipient, uint256 amount) internal{
require(address(this).balance>= amount, "Address: insufficient balance");
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value
(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._
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
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._
*/functionfunctionCall(address target, bytesmemory data, stringmemory errorMessage) internalreturns (bytesmemory) {
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._
*/functionfunctionCallWithValue(address target, bytesmemory data, uint256 value) internalreturns (bytesmemory) {
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._
*/functionfunctionCallWithValue(address target, bytesmemory data, uint256 value, stringmemory errorMessage) internalreturns (bytesmemory) {
require(address(this).balance>= value, "Address: insufficient balance for call");
require(isContract(target), "Address: call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytesmemory 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._
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
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._
*/functionfunctionStaticCall(address target, bytesmemory data, stringmemory errorMessage) internalviewreturns (bytesmemory) {
require(isContract(target), "Address: static call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytesmemory 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._
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
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._
*/functionfunctionDelegateCall(address target, bytesmemory data, stringmemory errorMessage) internalreturns (bytesmemory) {
require(isContract(target), "Address: delegate call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytesmemory returndata) = target.delegatecall(data);
return _verifyCallResult(success, returndata, errorMessage);
}
function_verifyCallResult(bool success, bytesmemory returndata, stringmemory errorMessage) privatepurereturns(bytesmemory) {
if (success) {
return returndata;
} else {
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assembly// solhint-disable-next-line no-inline-assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
Contract Source Code
File 2 of 27: Context.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <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.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (addresspayable) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytesmemory) {
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691returnmsg.data;
}
}
Contract Source Code
File 3 of 27: ERC165.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;import"./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts may inherit from this and call {_registerInterface} to declare
* their support of an interface.
*/abstractcontractERC165isIERC165{
/*
* bytes4(keccak256('supportsInterface(bytes4)')) == 0x01ffc9a7
*/bytes4privateconstant _INTERFACE_ID_ERC165 =0x01ffc9a7;
/**
* @dev Mapping of interface ids to whether or not it's supported.
*/mapping(bytes4=>bool) private _supportedInterfaces;
constructor () internal{
// Derived contracts need only register support for their own interfaces,// we register support for ERC165 itself here
_registerInterface(_INTERFACE_ID_ERC165);
}
/**
* @dev See {IERC165-supportsInterface}.
*
* Time complexity O(1), guaranteed to always use less than 30 000 gas.
*/functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverridereturns (bool) {
return _supportedInterfaces[interfaceId];
}
/**
* @dev Registers the contract as an implementer of the interface defined by
* `interfaceId`. Support of the actual ERC165 interface is automatic and
* registering its interface id is not required.
*
* See {IERC165-supportsInterface}.
*
* Requirements:
*
* - `interfaceId` cannot be the ERC165 invalid interface (`0xffffffff`).
*/function_registerInterface(bytes4 interfaceId) internalvirtual{
require(interfaceId !=0xffffffff, "ERC165: invalid interface id");
_supportedInterfaces[interfaceId] =true;
}
}
Contract Source Code
File 4 of 27: ERC721.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;import"../../utils/Context.sol";
import"./IERC721.sol";
import"./IERC721Metadata.sol";
import"./IERC721Enumerable.sol";
import"./IERC721Receiver.sol";
import"../../introspection/ERC165.sol";
import"../../math/SafeMath.sol";
import"../../utils/Address.sol";
import"../../utils/EnumerableSet.sol";
import"../../utils/EnumerableMap.sol";
import"../../utils/Strings.sol";
/**
* @title ERC721 Non-Fungible Token Standard basic implementation
* @dev see https://eips.ethereum.org/EIPS/eip-721
*/contractERC721isContext, ERC165, IERC721, IERC721Metadata, IERC721Enumerable{
usingSafeMathforuint256;
usingAddressforaddress;
usingEnumerableSetforEnumerableSet.UintSet;
usingEnumerableMapforEnumerableMap.UintToAddressMap;
usingStringsforuint256;
// Equals to `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`// which can be also obtained as `IERC721Receiver(0).onERC721Received.selector`bytes4privateconstant _ERC721_RECEIVED =0x150b7a02;
// Mapping from holder address to their (enumerable) set of owned tokensmapping (address=> EnumerableSet.UintSet) private _holderTokens;
// Enumerable mapping from token ids to their owners
EnumerableMap.UintToAddressMap private _tokenOwners;
// Mapping from token ID to approved addressmapping (uint256=>address) private _tokenApprovals;
// Mapping from owner to operator approvalsmapping (address=>mapping (address=>bool)) private _operatorApprovals;
// Token namestringprivate _name;
// Token symbolstringprivate _symbol;
// Optional mapping for token URIsmapping (uint256=>string) private _tokenURIs;
// Base URIstringprivate _baseURI;
/*
* bytes4(keccak256('balanceOf(address)')) == 0x70a08231
* bytes4(keccak256('ownerOf(uint256)')) == 0x6352211e
* bytes4(keccak256('approve(address,uint256)')) == 0x095ea7b3
* bytes4(keccak256('getApproved(uint256)')) == 0x081812fc
* bytes4(keccak256('setApprovalForAll(address,bool)')) == 0xa22cb465
* bytes4(keccak256('isApprovedForAll(address,address)')) == 0xe985e9c5
* bytes4(keccak256('transferFrom(address,address,uint256)')) == 0x23b872dd
* bytes4(keccak256('safeTransferFrom(address,address,uint256)')) == 0x42842e0e
* bytes4(keccak256('safeTransferFrom(address,address,uint256,bytes)')) == 0xb88d4fde
*
* => 0x70a08231 ^ 0x6352211e ^ 0x095ea7b3 ^ 0x081812fc ^
* 0xa22cb465 ^ 0xe985e9c5 ^ 0x23b872dd ^ 0x42842e0e ^ 0xb88d4fde == 0x80ac58cd
*/bytes4privateconstant _INTERFACE_ID_ERC721 =0x80ac58cd;
/*
* bytes4(keccak256('name()')) == 0x06fdde03
* bytes4(keccak256('symbol()')) == 0x95d89b41
* bytes4(keccak256('tokenURI(uint256)')) == 0xc87b56dd
*
* => 0x06fdde03 ^ 0x95d89b41 ^ 0xc87b56dd == 0x5b5e139f
*/bytes4privateconstant _INTERFACE_ID_ERC721_METADATA =0x5b5e139f;
/*
* bytes4(keccak256('totalSupply()')) == 0x18160ddd
* bytes4(keccak256('tokenOfOwnerByIndex(address,uint256)')) == 0x2f745c59
* bytes4(keccak256('tokenByIndex(uint256)')) == 0x4f6ccce7
*
* => 0x18160ddd ^ 0x2f745c59 ^ 0x4f6ccce7 == 0x780e9d63
*/bytes4privateconstant _INTERFACE_ID_ERC721_ENUMERABLE =0x780e9d63;
/**
* @dev Initializes the contract by setting a `name` and a `symbol` to the token collection.
*/constructor (stringmemory name_, stringmemory symbol_) public{
_name = name_;
_symbol = symbol_;
// register the supported interfaces to conform to ERC721 via ERC165
_registerInterface(_INTERFACE_ID_ERC721);
_registerInterface(_INTERFACE_ID_ERC721_METADATA);
_registerInterface(_INTERFACE_ID_ERC721_ENUMERABLE);
}
/**
* @dev See {IERC721-balanceOf}.
*/functionbalanceOf(address owner) publicviewvirtualoverridereturns (uint256) {
require(owner !=address(0), "ERC721: balance query for the zero address");
return _holderTokens[owner].length();
}
/**
* @dev See {IERC721-ownerOf}.
*/functionownerOf(uint256 tokenId) publicviewvirtualoverridereturns (address) {
return _tokenOwners.get(tokenId, "ERC721: owner query for nonexistent token");
}
/**
* @dev See {IERC721Metadata-name}.
*/functionname() publicviewvirtualoverridereturns (stringmemory) {
return _name;
}
/**
* @dev See {IERC721Metadata-symbol}.
*/functionsymbol() publicviewvirtualoverridereturns (stringmemory) {
return _symbol;
}
/**
* @dev See {IERC721Metadata-tokenURI}.
*/functiontokenURI(uint256 tokenId) publicviewvirtualoverridereturns (stringmemory) {
require(_exists(tokenId), "ERC721Metadata: URI query for nonexistent token");
stringmemory _tokenURI = _tokenURIs[tokenId];
stringmemory base = baseURI();
// If there is no base URI, return the token URI.if (bytes(base).length==0) {
return _tokenURI;
}
// If both are set, concatenate the baseURI and tokenURI (via abi.encodePacked).if (bytes(_tokenURI).length>0) {
returnstring(abi.encodePacked(base, _tokenURI));
}
// If there is a baseURI but no tokenURI, concatenate the tokenID to the baseURI.returnstring(abi.encodePacked(base, tokenId.toString()));
}
/**
* @dev Returns the base URI set via {_setBaseURI}. This will be
* automatically added as a prefix in {tokenURI} to each token's URI, or
* to the token ID if no specific URI is set for that token ID.
*/functionbaseURI() publicviewvirtualreturns (stringmemory) {
return _baseURI;
}
/**
* @dev See {IERC721Enumerable-tokenOfOwnerByIndex}.
*/functiontokenOfOwnerByIndex(address owner, uint256 index) publicviewvirtualoverridereturns (uint256) {
return _holderTokens[owner].at(index);
}
/**
* @dev See {IERC721Enumerable-totalSupply}.
*/functiontotalSupply() publicviewvirtualoverridereturns (uint256) {
// _tokenOwners are indexed by tokenIds, so .length() returns the number of tokenIdsreturn _tokenOwners.length();
}
/**
* @dev See {IERC721Enumerable-tokenByIndex}.
*/functiontokenByIndex(uint256 index) publicviewvirtualoverridereturns (uint256) {
(uint256 tokenId, ) = _tokenOwners.at(index);
return tokenId;
}
/**
* @dev See {IERC721-approve}.
*/functionapprove(address to, uint256 tokenId) publicvirtualoverride{
address owner = ERC721.ownerOf(tokenId);
require(to != owner, "ERC721: approval to current owner");
require(_msgSender() == owner || ERC721.isApprovedForAll(owner, _msgSender()),
"ERC721: approve caller is not owner nor approved for all"
);
_approve(to, tokenId);
}
/**
* @dev See {IERC721-getApproved}.
*/functiongetApproved(uint256 tokenId) publicviewvirtualoverridereturns (address) {
require(_exists(tokenId), "ERC721: approved query for nonexistent token");
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/functionsetApprovalForAll(address operator, bool approved) publicvirtualoverride{
require(operator != _msgSender(), "ERC721: approve to caller");
_operatorApprovals[_msgSender()][operator] = approved;
emit ApprovalForAll(_msgSender(), operator, approved);
}
/**
* @dev See {IERC721-isApprovedForAll}.
*/functionisApprovedForAll(address owner, address operator) publicviewvirtualoverridereturns (bool) {
return _operatorApprovals[owner][operator];
}
/**
* @dev See {IERC721-transferFrom}.
*/functiontransferFrom(addressfrom, address to, uint256 tokenId) publicvirtualoverride{
//solhint-disable-next-line max-line-lengthrequire(_isApprovedOrOwner(_msgSender(), tokenId), "ERC721: transfer caller is not owner nor approved");
_transfer(from, to, tokenId);
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/functionsafeTransferFrom(addressfrom, address to, uint256 tokenId) publicvirtualoverride{
safeTransferFrom(from, to, tokenId, "");
}
/**
* @dev See {IERC721-safeTransferFrom}.
*/functionsafeTransferFrom(addressfrom, address to, uint256 tokenId, bytesmemory _data) publicvirtualoverride{
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(addressfrom, address to, uint256 tokenId, bytesmemory _data) internalvirtual{
_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) internalviewvirtualreturns (bool) {
return _tokenOwners.contains(tokenId);
}
/**
* @dev Returns whether `spender` is allowed to manage `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/function_isApprovedOrOwner(address spender, uint256 tokenId) internalviewvirtualreturns (bool) {
require(_exists(tokenId), "ERC721: operator query for nonexistent token");
address owner = ERC721.ownerOf(tokenId);
return (spender == owner || getApproved(tokenId) == spender || ERC721.isApprovedForAll(owner, spender));
}
/**
* @dev Safely mints `tokenId` and transfers it to `to`.
*
* Requirements:
d*
* - `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) internalvirtual{
_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, bytesmemory _data) internalvirtual{
_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) internalvirtual{
require(to !=address(0), "ERC721: mint to the zero address");
require(!_exists(tokenId), "ERC721: token already minted");
_beforeTokenTransfer(address(0), to, tokenId);
_holderTokens[to].add(tokenId);
_tokenOwners.set(tokenId, to);
emit Transfer(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) internalvirtual{
address owner = ERC721.ownerOf(tokenId); // internal owner
_beforeTokenTransfer(owner, address(0), tokenId);
// Clear approvals
_approve(address(0), tokenId);
// Clear metadata (if any)if (bytes(_tokenURIs[tokenId]).length!=0) {
delete _tokenURIs[tokenId];
}
_holderTokens[owner].remove(tokenId);
_tokenOwners.remove(tokenId);
emit Transfer(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(addressfrom, address to, uint256 tokenId) internalvirtual{
require(ERC721.ownerOf(tokenId) ==from, "ERC721: transfer of token that is not own"); // internal ownerrequire(to !=address(0), "ERC721: transfer to the zero address");
_beforeTokenTransfer(from, to, tokenId);
// Clear approvals from the previous owner
_approve(address(0), tokenId);
_holderTokens[from].remove(tokenId);
_holderTokens[to].add(tokenId);
_tokenOwners.set(tokenId, to);
emit Transfer(from, to, tokenId);
}
/**
* @dev Sets `_tokenURI` as the tokenURI of `tokenId`.
*
* Requirements:
*
* - `tokenId` must exist.
*/function_setTokenURI(uint256 tokenId, stringmemory _tokenURI) internalvirtual{
require(_exists(tokenId), "ERC721Metadata: URI set of nonexistent token");
_tokenURIs[tokenId] = _tokenURI;
}
/**
* @dev Internal function to set the base URI for all token IDs. It is
* automatically added as a prefix to the value returned in {tokenURI},
* or to the token ID if {tokenURI} is empty.
*/function_setBaseURI(stringmemory baseURI_) internalvirtual{
_baseURI = baseURI_;
}
/**
* @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(addressfrom, address to, uint256 tokenId, bytesmemory _data)
privatereturns (bool)
{
if (!to.isContract()) {
returntrue;
}
bytesmemory returndata = to.functionCall(abi.encodeWithSelector(
IERC721Receiver(to).onERC721Received.selector,
_msgSender(),
from,
tokenId,
_data
), "ERC721: transfer to non ERC721Receiver implementer");
bytes4 retval =abi.decode(returndata, (bytes4));
return (retval == _ERC721_RECEIVED);
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits an {Approval} event.
*/function_approve(address to, uint256 tokenId) internalvirtual{
_tokenApprovals[tokenId] = to;
emit Approval(ERC721.ownerOf(tokenId), to, tokenId); // internal owner
}
/**
* @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(addressfrom, address to, uint256 tokenId) internalvirtual{ }
}
Contract Source Code
File 5 of 27: EnumerableMap.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @dev Library for managing an enumerable variant of Solidity's
* https://solidity.readthedocs.io/en/latest/types.html#mapping-types[`mapping`]
* type.
*
* Maps have the following properties:
*
* - Entries are added, removed, and checked for existence in constant time
* (O(1)).
* - Entries are enumerated in O(n). No guarantees are made on the ordering.
*
* ```
* contract Example {
* // Add the library methods
* using EnumerableMap for EnumerableMap.UintToAddressMap;
*
* // Declare a set state variable
* EnumerableMap.UintToAddressMap private myMap;
* }
* ```
*
* As of v3.0.0, only maps of type `uint256 -> address` (`UintToAddressMap`) are
* supported.
*/libraryEnumerableMap{
// To implement this library for multiple types with as little code// repetition as possible, we write it in terms of a generic Map type with// bytes32 keys and values.// The Map implementation uses private functions, and user-facing// implementations (such as Uint256ToAddressMap) are just wrappers around// the underlying Map.// This means that we can only create new EnumerableMaps for types that fit// in bytes32.structMapEntry {
bytes32 _key;
bytes32 _value;
}
structMap {
// Storage of map keys and values
MapEntry[] _entries;
// Position of the entry defined by a key in the `entries` array, plus 1// because index 0 means a key is not in the map.mapping (bytes32=>uint256) _indexes;
}
/**
* @dev Adds a key-value pair to a map, or updates the value for an existing
* key. O(1).
*
* Returns true if the key was added to the map, that is if it was not
* already present.
*/function_set(Map storage map, bytes32 key, bytes32 value) privatereturns (bool) {
// We read and store the key's index to prevent multiple reads from the same storage slotuint256 keyIndex = map._indexes[key];
if (keyIndex ==0) { // Equivalent to !contains(map, key)
map._entries.push(MapEntry({ _key: key, _value: value }));
// The entry is stored at length-1, but we add 1 to all indexes// and use 0 as a sentinel value
map._indexes[key] = map._entries.length;
returntrue;
} else {
map._entries[keyIndex -1]._value = value;
returnfalse;
}
}
/**
* @dev Removes a key-value pair from a map. O(1).
*
* Returns true if the key was removed from the map, that is if it was present.
*/function_remove(Map storage map, bytes32 key) privatereturns (bool) {
// We read and store the key's index to prevent multiple reads from the same storage slotuint256 keyIndex = map._indexes[key];
if (keyIndex !=0) { // Equivalent to contains(map, key)// To delete a key-value pair from the _entries array in O(1), we swap the entry to delete with the last one// in the array, and then remove the last entry (sometimes called as 'swap and pop').// This modifies the order of the array, as noted in {at}.uint256 toDeleteIndex = keyIndex -1;
uint256 lastIndex = map._entries.length-1;
// When the entry to delete is the last one, the swap operation is unnecessary. However, since this occurs// so rarely, we still do the swap anyway to avoid the gas cost of adding an 'if' statement.
MapEntry storage lastEntry = map._entries[lastIndex];
// Move the last entry to the index where the entry to delete is
map._entries[toDeleteIndex] = lastEntry;
// Update the index for the moved entry
map._indexes[lastEntry._key] = toDeleteIndex +1; // All indexes are 1-based// Delete the slot where the moved entry was stored
map._entries.pop();
// Delete the index for the deleted slotdelete map._indexes[key];
returntrue;
} else {
returnfalse;
}
}
/**
* @dev Returns true if the key is in the map. O(1).
*/function_contains(Map storage map, bytes32 key) privateviewreturns (bool) {
return map._indexes[key] !=0;
}
/**
* @dev Returns the number of key-value pairs in the map. O(1).
*/function_length(Map storage map) privateviewreturns (uint256) {
return map._entries.length;
}
/**
* @dev Returns the key-value pair stored at position `index` in the map. O(1).
*
* Note that there are no guarantees on the ordering of entries inside the
* array, and it may change when more entries are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/function_at(Map storage map, uint256 index) privateviewreturns (bytes32, bytes32) {
require(map._entries.length> index, "EnumerableMap: index out of bounds");
MapEntry storage entry = map._entries[index];
return (entry._key, entry._value);
}
/**
* @dev Tries to returns the value associated with `key`. O(1).
* Does not revert if `key` is not in the map.
*/function_tryGet(Map storage map, bytes32 key) privateviewreturns (bool, bytes32) {
uint256 keyIndex = map._indexes[key];
if (keyIndex ==0) return (false, 0); // Equivalent to contains(map, key)return (true, map._entries[keyIndex -1]._value); // All indexes are 1-based
}
/**
* @dev Returns the value associated with `key`. O(1).
*
* Requirements:
*
* - `key` must be in the map.
*/function_get(Map storage map, bytes32 key) privateviewreturns (bytes32) {
uint256 keyIndex = map._indexes[key];
require(keyIndex !=0, "EnumerableMap: nonexistent key"); // Equivalent to contains(map, key)return map._entries[keyIndex -1]._value; // All indexes are 1-based
}
/**
* @dev Same as {_get}, with a custom error message when `key` is not in the map.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {_tryGet}.
*/function_get(Map storage map, bytes32 key, stringmemory errorMessage) privateviewreturns (bytes32) {
uint256 keyIndex = map._indexes[key];
require(keyIndex !=0, errorMessage); // Equivalent to contains(map, key)return map._entries[keyIndex -1]._value; // All indexes are 1-based
}
// UintToAddressMapstructUintToAddressMap {
Map _inner;
}
/**
* @dev Adds a key-value pair to a map, or updates the value for an existing
* key. O(1).
*
* Returns true if the key was added to the map, that is if it was not
* already present.
*/functionset(UintToAddressMap storage map, uint256 key, address value) internalreturns (bool) {
return _set(map._inner, bytes32(key), bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the key was removed from the map, that is if it was present.
*/functionremove(UintToAddressMap storage map, uint256 key) internalreturns (bool) {
return _remove(map._inner, bytes32(key));
}
/**
* @dev Returns true if the key is in the map. O(1).
*/functioncontains(UintToAddressMap storage map, uint256 key) internalviewreturns (bool) {
return _contains(map._inner, bytes32(key));
}
/**
* @dev Returns the number of elements in the map. O(1).
*/functionlength(UintToAddressMap storage map) internalviewreturns (uint256) {
return _length(map._inner);
}
/**
* @dev Returns the element stored at position `index` in the set. O(1).
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/functionat(UintToAddressMap storage map, uint256 index) internalviewreturns (uint256, address) {
(bytes32 key, bytes32 value) = _at(map._inner, index);
return (uint256(key), address(uint160(uint256(value))));
}
/**
* @dev Tries to returns the value associated with `key`. O(1).
* Does not revert if `key` is not in the map.
*
* _Available since v3.4._
*/functiontryGet(UintToAddressMap storage map, uint256 key) internalviewreturns (bool, address) {
(bool success, bytes32 value) = _tryGet(map._inner, bytes32(key));
return (success, address(uint160(uint256(value))));
}
/**
* @dev Returns the value associated with `key`. O(1).
*
* Requirements:
*
* - `key` must be in the map.
*/functionget(UintToAddressMap storage map, uint256 key) internalviewreturns (address) {
returnaddress(uint160(uint256(_get(map._inner, bytes32(key)))));
}
/**
* @dev Same as {get}, with a custom error message when `key` is not in the map.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryGet}.
*/functionget(UintToAddressMap storage map, uint256 key, stringmemory errorMessage) internalviewreturns (address) {
returnaddress(uint160(uint256(_get(map._inner, bytes32(key), errorMessage))));
}
}
Contract Source Code
File 6 of 27: EnumerableSet.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @dev Library for managing
* https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive
* types.
*
* Sets have the following properties:
*
* - Elements are added, removed, and checked for existence in constant time
* (O(1)).
* - Elements are enumerated in O(n). No guarantees are made on the ordering.
*
* ```
* contract Example {
* // Add the library methods
* using EnumerableSet for EnumerableSet.AddressSet;
*
* // Declare a set state variable
* EnumerableSet.AddressSet private mySet;
* }
* ```
*
* As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)
* and `uint256` (`UintSet`) are supported.
*/libraryEnumerableSet{
// To implement this library for multiple types with as little code// repetition as possible, we write it in terms of a generic Set type with// bytes32 values.// The Set implementation uses private functions, and user-facing// implementations (such as AddressSet) are just wrappers around the// underlying Set.// This means that we can only create new EnumerableSets for types that fit// in bytes32.structSet {
// Storage of set valuesbytes32[] _values;
// Position of the value in the `values` array, plus 1 because index 0// means a value is not in the set.mapping (bytes32=>uint256) _indexes;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/function_add(Set storage set, bytes32 value) privatereturns (bool) {
if (!_contains(set, value)) {
set._values.push(value);
// The value is stored at length-1, but we add 1 to all indexes// and use 0 as a sentinel value
set._indexes[value] = set._values.length;
returntrue;
} else {
returnfalse;
}
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/function_remove(Set storage set, bytes32 value) privatereturns (bool) {
// We read and store the value's index to prevent multiple reads from the same storage slotuint256 valueIndex = set._indexes[value];
if (valueIndex !=0) { // Equivalent to contains(set, value)// To delete an element from the _values array in O(1), we swap the element to delete with the last one in// the array, and then remove the last element (sometimes called as 'swap and pop').// This modifies the order of the array, as noted in {at}.uint256 toDeleteIndex = valueIndex -1;
uint256 lastIndex = set._values.length-1;
// When the value to delete is the last one, the swap operation is unnecessary. However, since this occurs// so rarely, we still do the swap anyway to avoid the gas cost of adding an 'if' statement.bytes32 lastvalue = set._values[lastIndex];
// Move the last value to the index where the value to delete is
set._values[toDeleteIndex] = lastvalue;
// Update the index for the moved value
set._indexes[lastvalue] = toDeleteIndex +1; // All indexes are 1-based// Delete the slot where the moved value was stored
set._values.pop();
// Delete the index for the deleted slotdelete set._indexes[value];
returntrue;
} else {
returnfalse;
}
}
/**
* @dev Returns true if the value is in the set. O(1).
*/function_contains(Set storage set, bytes32 value) privateviewreturns (bool) {
return set._indexes[value] !=0;
}
/**
* @dev Returns the number of values on the set. O(1).
*/function_length(Set storage set) privateviewreturns (uint256) {
return set._values.length;
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/function_at(Set storage set, uint256 index) privateviewreturns (bytes32) {
require(set._values.length> index, "EnumerableSet: index out of bounds");
return set._values[index];
}
// Bytes32SetstructBytes32Set {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/functionadd(Bytes32Set storage set, bytes32 value) internalreturns (bool) {
return _add(set._inner, value);
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/functionremove(Bytes32Set storage set, bytes32 value) internalreturns (bool) {
return _remove(set._inner, value);
}
/**
* @dev Returns true if the value is in the set. O(1).
*/functioncontains(Bytes32Set storage set, bytes32 value) internalviewreturns (bool) {
return _contains(set._inner, value);
}
/**
* @dev Returns the number of values in the set. O(1).
*/functionlength(Bytes32Set storage set) internalviewreturns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/functionat(Bytes32Set storage set, uint256 index) internalviewreturns (bytes32) {
return _at(set._inner, index);
}
// AddressSetstructAddressSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/functionadd(AddressSet storage set, address value) internalreturns (bool) {
return _add(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/functionremove(AddressSet storage set, address value) internalreturns (bool) {
return _remove(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/functioncontains(AddressSet storage set, address value) internalviewreturns (bool) {
return _contains(set._inner, bytes32(uint256(uint160(value))));
}
/**
* @dev Returns the number of values in the set. O(1).
*/functionlength(AddressSet storage set) internalviewreturns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/functionat(AddressSet storage set, uint256 index) internalviewreturns (address) {
returnaddress(uint160(uint256(_at(set._inner, index))));
}
// UintSetstructUintSet {
Set _inner;
}
/**
* @dev Add a value to a set. O(1).
*
* Returns true if the value was added to the set, that is if it was not
* already present.
*/functionadd(UintSet storage set, uint256 value) internalreturns (bool) {
return _add(set._inner, bytes32(value));
}
/**
* @dev Removes a value from a set. O(1).
*
* Returns true if the value was removed from the set, that is if it was
* present.
*/functionremove(UintSet storage set, uint256 value) internalreturns (bool) {
return _remove(set._inner, bytes32(value));
}
/**
* @dev Returns true if the value is in the set. O(1).
*/functioncontains(UintSet storage set, uint256 value) internalviewreturns (bool) {
return _contains(set._inner, bytes32(value));
}
/**
* @dev Returns the number of values on the set. O(1).
*/functionlength(UintSet storage set) internalviewreturns (uint256) {
return _length(set._inner);
}
/**
* @dev Returns the value stored at position `index` in the set. O(1).
*
* Note that there are no guarantees on the ordering of values inside the
* array, and it may change when more values are added or removed.
*
* Requirements:
*
* - `index` must be strictly less than {length}.
*/functionat(UintSet storage set, uint256 index) internalviewreturns (uint256) {
returnuint256(_at(set._inner, index));
}
}
Contract Source Code
File 7 of 27: EthPrimaryMarket.sol
// SPDX-License-Identifier: GPL-3.0-or-laterpragmasolidity >=0.6.10 <0.8.0;pragmaexperimentalABIEncoderV2;import"@openzeppelin/contracts/math/Math.sol";
import"@openzeppelin/contracts/math/SafeMath.sol";
import"@openzeppelin/contracts/token/ERC20/IERC20.sol";
import"@openzeppelin/contracts/token/ERC20/SafeERC20.sol";
import"@openzeppelin/contracts/utils/ReentrancyGuard.sol";
import"@openzeppelin/contracts/access/Ownable.sol";
import"@openzeppelin/contracts/token/ERC721/ERC721.sol";
import"../../utils/SafeDecimalMath.sol";
import"../../interfaces/IFundV4.sol";
import"../../interfaces/IFundForPrimaryMarketV4.sol";
import"../../interfaces/ITrancheIndexV2.sol";
import"../../interfaces/IWrappedERC20.sol";
interfaceINonfungibleRedemptionDescriptor{
functiontokenURI(uint256 tokenId,
uint256 amountQ,
uint256 amountUnderlying,
uint256 seed
) externalviewreturns (stringmemory);
functiongenerateSeed(uint256 tokenId, uint256 amountQ) externalviewreturns (uint256);
}
/// @title EIP-721 Metadata Update ExtensioninterfaceIERC4906isIERC165, IERC721{
/// @dev This event emits when the metadata of a token is changed./// So that the third-party platforms such as NFT market could/// timely update the images and related attributes of the NFT.eventMetadataUpdate(uint256 _tokenId);
/// @dev This event emits when the metadata of a range of tokens is changed./// So that the third-party platforms such as NFT market could/// timely update the images and related attributes of the NFTs.eventBatchMetadataUpdate(uint256 _fromTokenId, uint256 _toTokenId);
}
contractEthPrimaryMarketisReentrancyGuard, ITrancheIndexV2, Ownable, ERC721, IERC4906{
eventCreated(addressindexed account, uint256 underlying, uint256 outQ);
eventRedeemed(addressindexed account, uint256 inQ, uint256 underlying, uint256 feeQ);
eventSplit(addressindexed account, uint256 inQ, uint256 outB, uint256 outR);
eventMerged(addressindexed account,
uint256 outQ,
uint256 inB,
uint256 inR,
uint256 feeUnderlying
);
eventRedemptionQueued(addressindexed account, uint256 index, uint256 underlying);
eventRedemptionFinalized(uint256 nextFinalizationIndex, uint256 inQ, uint256 underlying);
eventRedemptionPopped(uint256 count, uint256 newHead, uint256 requiredUnderlying);
eventRedemptionClaimed(addressindexed account, uint256 index, uint256 underlying);
eventFundCapUpdated(uint256 newCap);
eventMergeFeeRateUpdated(uint256 newMergeFeeRate);
eventRedemptionBoundsUpdated(uint256 newLowerBound, uint256 newUpperBound);
usingMathforuint256;
usingSafeMathforuint256;
usingSafeDecimalMathforuint256;
usingSafeERC20forIERC20;
structQueuedRedemption {
uint256 amountQ;
uint256 previousPrefixSum;
uint256 seed;
}
structRedemptionRate {
uint256 nextIndex;
// ETH/Queen rate is with 10^27 precision.uint256 underlyingPerQ;
}
uint256privateconstant MAX_MERGE_FEE_RATE =0.01e18;
uint256publicconstant redemptionFeeRate =0;
addresspublicimmutable fund;
IERC20 privateimmutable _tokenUnderlying;
INonfungibleRedemptionDescriptor privateimmutable _descriptor;
uint256public mergeFeeRate;
/// @notice The upper limit of underlying that the fund can hold. This contract rejects/// creations that may break this limit.uint256public fundCap;
/// @notice Queue of redemptions that cannot be claimed yet. Key is a sequential index/// starting from zero. Value is a tuple of redeemed QUEEN and prefix sum before/// this entry.mapping(uint256=> QueuedRedemption) public queuedRedemptions;
/// @notice Total underlying tokens of claimable queued redemptions.uint256public claimableUnderlying;
/// @notice Index of the redemption queue head. All redemptions with index smaller than/// this value can be claimed now.uint256public redemptionQueueHead;
/// @notice Index of the redemption following the last entry of the queue. The next queued/// redemption will be written at this index.uint256public redemptionQueueTail;
/// @notice Rates of underlying tokens per redeemed QUEEN. Key is a sequential index starting/// from zero. Each value corresponds to a continuous part of the redemption queue that/// was finalized in a single transaction.mapping(uint256=> RedemptionRate) public redemptionRates;
/// @notice Total number of redemption rates.uint256public redemptionRateSize;
/// @notice Minimal amount to redeem by a single requestuint256public minRedemptionBound;
/// @notice Maximum amount to redeem by a single requestuint256public maxRedemptionBound;
constructor(address fund_,
uint256 mergeFeeRate_,
uint256 fundCap_,
stringmemory name_,
stringmemory symbol_,
address descriptor_,
uint256 minRedemptionBound_,
uint256 maxRedemptionBound_
) publicOwnable() ERC721(name_, symbol_) {
fund = fund_;
_tokenUnderlying = IERC20(IFundV4(fund_).tokenUnderlying());
_updateMergeFeeRate(mergeFeeRate_);
_updateFundCap(fundCap_);
_descriptor = INonfungibleRedemptionDescriptor(descriptor_);
_updateRedemptionBounds(minRedemptionBound_, maxRedemptionBound_);
_registerInterface(bytes4(0x49064906));
}
/// @notice Calculate the result of a creation./// @param underlying Underlying amount spent for the creation/// @return outQ Created QUEEN amountfunctiongetCreation(uint256 underlying) publicviewreturns (uint256 outQ) {
uint256 fundUnderlying = IFundV4(fund).getTotalUnderlying();
uint256 fundEquivalentTotalQ = IFundV4(fund).getEquivalentTotalQ();
require(fundUnderlying.add(underlying) <= fundCap, "Exceed fund cap");
if (fundEquivalentTotalQ ==0) {
outQ = underlying.mul(IFundV4(fund).underlyingDecimalMultiplier());
uint256 splitRatio = IFundV4(fund).splitRatio();
require(splitRatio !=0, "Fund is not initialized");
uint256 settledDay = IFundV4(fund).currentDay() -1days;
uint256 underlyingPrice = IFundV4(fund).twapOracle().getTwap(settledDay);
(uint256 navB, uint256 navR) = IFundV4(fund).historicalNavs(settledDay);
outQ = outQ.mul(underlyingPrice).div(splitRatio).divideDecimal(navB.add(navR));
} else {
require(
fundUnderlying !=0,
"Cannot create QUEEN for fund with shares but no underlying"
);
outQ = underlying.mul(fundEquivalentTotalQ).div(fundUnderlying);
}
}
/// @notice Calculate the amount of underlying tokens to create at least the given QUEEN amount./// This only works with non-empty fund for simplicity./// @param minOutQ Minimum received QUEEN amount/// @return underlying Underlying amount that should be used for creationfunctiongetCreationForQ(uint256 minOutQ) externalviewreturns (uint256 underlying) {
// Assume:// minOutQ * fundUnderlying = a * fundEquivalentTotalQ - b// where a and b are integers and 0 <= b < fundEquivalentTotalQ// Then// underlying = a// getCreation(underlying)// = floor(a * fundEquivalentTotalQ / fundUnderlying)// >= floor((a * fundEquivalentTotalQ - b) / fundUnderlying)// = minOutQ// getCreation(underlying - 1)// = floor((a * fundEquivalentTotalQ - fundEquivalentTotalQ) / fundUnderlying)// < (a * fundEquivalentTotalQ - b) / fundUnderlying// = minOutQuint256 fundUnderlying = IFundV4(fund).getTotalUnderlying();
uint256 fundEquivalentTotalQ = IFundV4(fund).getEquivalentTotalQ();
require(fundEquivalentTotalQ >0, "Cannot calculate creation for empty fund");
return minOutQ.mul(fundUnderlying).add(fundEquivalentTotalQ -1).div(fundEquivalentTotalQ);
}
function_getRedemption(uint256 inQ) privateviewreturns (uint256 underlying) {
uint256 fundUnderlying = IFundV4(fund).getTotalUnderlying();
uint256 fundEquivalentTotalQ = IFundV4(fund).getEquivalentTotalQ();
underlying = inQ.mul(fundUnderlying).div(fundEquivalentTotalQ);
}
/// @notice Calculate the result of a redemption./// @param inQ QUEEN amount spent for the redemption/// @return underlying Redeemed underlying amount/// @return feeQ QUEEN amount charged as redemption feefunctiongetRedemption(uint256 inQ) publicviewreturns (uint256 underlying, uint256 feeQ) {
underlying = _getRedemption(inQ);
feeQ =0;
}
/// @notice Calculate the amount of QUEEN that can be redeemed for at least the given amount/// of underlying tokens./// @dev The return value may not be the minimum solution due to rounding errors./// @param minUnderlying Minimum received underlying amount/// @return inQ QUEEN amount that should be redeemedfunctiongetRedemptionForUnderlying(uint256 minUnderlying) externalviewreturns (uint256 inQ) {
// Assume:// minUnderlying * fundEquivalentTotalQ = a * fundUnderlying - b// a * 1e18 = c * (1e18 - redemptionFeeRate) + d// where// a, b, c, d are integers// 0 <= b < fundUnderlying// 0 <= d < 1e18 - redemeptionFeeRate// Then// inQAfterFee = a// inQ = c// underlying// = floor((c - floor(c * redemptionFeeRate / 1e18)) * fundUnderlying / fundEquivalentTotalQ)// = floor(ceil(c * (1e18 - redemptionFeeRate) / 1e18) * fundUnderlying / fundEquivalentTotalQ)// = floor(((c * (1e18 - redemptionFeeRate) + d) / 1e18) * fundUnderlying / fundEquivalentTotalQ)// = floor(a * fundUnderlying / fundEquivalentTotalQ)// => floor((a * fundUnderlying - b) / fundEquivalentTotalQ)// = minUnderlyinguint256 fundUnderlying = IFundV4(fund).getTotalUnderlying();
uint256 fundEquivalentTotalQ = IFundV4(fund).getEquivalentTotalQ();
uint256 inQAfterFee =
minUnderlying.mul(fundEquivalentTotalQ).add(fundUnderlying -1).div(fundUnderlying);
return inQAfterFee.divideDecimal(1e18- redemptionFeeRate);
}
/// @notice Calculate the result of a split./// @param inQ QUEEN amount to be split/// @return outB Received BISHOP amount, which is also received ROOK amountfunctiongetSplit(uint256 inQ) publicviewreturns (uint256 outB) {
return inQ.multiplyDecimal(IFundV4(fund).splitRatio());
}
/// @notice Calculate the amount of QUEEN that can be split into at least the given amount of/// BISHOP and ROOK./// @param minOutB Received BISHOP amount, which is also received ROOK amount/// @return inQ QUEEN amount that should be splitfunctiongetSplitForB(uint256 minOutB) externalviewreturns (uint256 inQ) {
uint256 splitRatio = IFundV4(fund).splitRatio();
return minOutB.mul(1e18).add(splitRatio.sub(1)).div(splitRatio);
}
/// @notice Calculate the result of a merge./// @param inB Spent BISHOP amount, which is also spent ROOK amount/// @return outQ Received QUEEN amount/// @return feeQ QUEEN amount charged as merge feefunctiongetMerge(uint256 inB) publicviewreturns (uint256 outQ, uint256 feeQ) {
uint256 outQBeforeFee = inB.divideDecimal(IFundV4(fund).splitRatio());
feeQ = outQBeforeFee.multiplyDecimal(mergeFeeRate);
outQ = outQBeforeFee.sub(feeQ);
}
/// @notice Calculate the amount of BISHOP and ROOK that can be merged into at least/// the given amount of QUEEN./// @dev The return value may not be the minimum solution due to rounding errors./// @param minOutQ Minimum received QUEEN amount/// @return inB BISHOP amount that should be merged, which is also spent ROOK amountfunctiongetMergeForQ(uint256 minOutQ) externalviewreturns (uint256 inB) {
// Assume:// minOutQ * 1e18 = a * (1e18 - mergeFeeRate) + b// c = ceil(a * splitRatio / 1e18)// where a and b are integers and 0 <= b < 1e18 - mergeFeeRate// Then// outQBeforeFee = a// inB = c// getMerge(inB).outQ// = c * 1e18 / splitRatio - floor(c * 1e18 / splitRatio * mergeFeeRate / 1e18)// = ceil(c * 1e18 / splitRatio * (1e18 - mergeFeeRate) / 1e18)// >= ceil(a * (1e18 - mergeFeeRate) / 1e18)// = (a * (1e18 - mergeFeeRate) + b) / 1e18 // because b < 1e18// = minOutQuint256 outQBeforeFee = minOutQ.divideDecimal(1e18- mergeFeeRate);
inB = outQBeforeFee.mul(IFundV4(fund).splitRatio()).add(1e18-1).div(1e18);
}
/// @notice Return index of the first queued redemption that cannot be claimed now./// Users can use this function to determine which indices can be passed to/// `claimRedemptions()`./// @return Index of the first redemption that cannot be claimed nowfunctiongetNewRedemptionQueueHead() publicviewreturns (uint256) {
uint256 available = _tokenUnderlying.balanceOf(fund);
uint256 l = redemptionQueueHead;
uint256 startPrefixSum = queuedRedemptions[l].previousPrefixSum;
uint256 rateSize = redemptionRateSize;
uint256 rateIndex = getRedemptionRateIndex(l);
uint256 r = l;
while (rateIndex < rateSize) {
r = redemptionRates[rateIndex].nextIndex;
uint256 endPrefixSum = queuedRedemptions[r].previousPrefixSum;
uint256 underlying =
(endPrefixSum - startPrefixSum).multiplyDecimalPrecise(
redemptionRates[rateIndex].underlyingPerQ
);
if (available < underlying) {
break;
}
available -= underlying;
l = r;
startPrefixSum = endPrefixSum;
rateIndex +=1;
}
if (rateIndex >= rateSize) {
return r; // All finalized redemptions can be claimed
}
// Iteration count is bounded by log2(tail - head), which is at most 256.uint256 underlyingPerQ = redemptionRates[rateIndex].underlyingPerQ;
while (l +1< r) {
uint256 m = (l + r) /2;
uint256 underlying =
(queuedRedemptions[m].previousPrefixSum - startPrefixSum).multiplyDecimalPrecise(
underlyingPerQ
);
if (underlying <= available) {
l = m;
} else {
r = m;
}
}
return l;
}
functiongetRedemptionRateIndexOfHead() externalviewreturns (uint256) {
return getRedemptionRateIndex(redemptionQueueHead);
}
/// @notice Search the redemption rate index of a queued redemption./// @return Index of the redemption rate that covers the given queued redemption, or index/// beyond the last redemption rate if this redemption is not finalized yet.functiongetRedemptionRateIndex(uint256 index) publicviewreturns (uint256) {
uint256 l =0;
uint256 r = redemptionRateSize;
if (r ==0) return0;
// If the index is greater than the redemption rate size, it is not yet finalized.// Return the index of the next potential finalization.if (redemptionRates[r -1].nextIndex <= index) {
return r;
}
while (l +1< r) {
uint256 m = (l + r) /2;
if (redemptionRates[m -1].nextIndex <= index) {
l = m;
} else {
r = m;
}
}
return l;
}
/// @notice Return claimable underlying tokens of a queued redemption, or zero if/// the redemption is not finalized yet.functiongetRedemptionUnderlying(uint256 index) publicviewreturns (uint256) {
uint256 rateIndex = getRedemptionRateIndex(index);
return
rateIndex < redemptionRateSize
? queuedRedemptions[index].amountQ.multiplyDecimalPrecise(
redemptionRates[rateIndex].underlyingPerQ
)
: 0;
}
/// @notice Get queued redemptions of an account. This function returns all information/// required to claim underlying tokens from these redemptions./// @param account Owner of the redemptions/// @return indices Indices of found redemptions. Note that there are no guarantees on the/// ordering./// @return rateIndices Redemption rate indices of found redemptions/// @return rateIndexOfHead Redemption rate index of the first redemption in the queue/// (index `redemptionQueueHead`)/// @return newRedemptionQueueHead Index of the first redemption that cannot be claimed now/// @return amountQ Total amount of QUEEN in found redemptions/// @return underlying Total claimable underlying tokens in found redemptionsfunctiongetQueuedRedemptions(address account)
externalviewreturns (uint256[] memory indices,
uint256[] memory rateIndices,
uint256 rateIndexOfHead,
uint256 newRedemptionQueueHead,
uint256 amountQ,
uint256 underlying
)
{
newRedemptionQueueHead = getNewRedemptionQueueHead();
uint256 count = balanceOf(account);
indices =newuint256[](count);
rateIndices =newuint256[](count);
for (uint256 i =0; i < count; i++) {
uint256 index = tokenOfOwnerByIndex(account, i);
indices[i] = index;
rateIndices[i] = getRedemptionRateIndex(index);
amountQ += queuedRedemptions[index].amountQ;
if (index < newRedemptionQueueHead) {
underlying += getRedemptionUnderlying(index);
}
}
rateIndexOfHead = getRedemptionRateIndex(redemptionQueueHead);
}
functiongetNextFinalizationIndex() publicviewreturns (uint256 index) {
if (redemptionRateSize ==0) return0;
return redemptionRates[redemptionRateSize -1].nextIndex;
}
/// @notice Return whether the fund can change its primary market to another contract.functioncanBeRemovedFromFund() externalviewreturns (bool) {
return redemptionQueueHead == redemptionQueueTail;
}
functiontokenURI(uint256 tokenId) publicviewoverridereturns (stringmemory) {
require(_exists(tokenId));
uint256 amountQ = queuedRedemptions[tokenId].amountQ;
uint256 amountUnderlying = getRedemptionUnderlying(tokenId);
return
_descriptor.tokenURI(
tokenId,
amountQ,
amountUnderlying,
queuedRedemptions[tokenId].seed
);
}
// save bytecode by removing implementation of unused methodfunctionbaseURI() publicviewoverridereturns (stringmemory) {}
/// @notice Create QUEEN using underlying tokens. This function should be called by/// a smart contract, which transfers underlying tokens to this contract/// in the same transaction./// @param recipient Address that will receive created QUEEN/// @param minOutQ Minimum QUEEN amount to be received/// @param version The latest rebalance version/// @return outQ Received QUEEN amountfunctioncreate(address recipient,
uint256 minOutQ,
uint256 version
) externalnonReentrantreturns (uint256 outQ) {
uint256 underlying = _tokenUnderlying.balanceOf(address(this)).sub(claimableUnderlying);
outQ = getCreation(underlying);
require(outQ >= minOutQ && outQ >0, "Min QUEEN created");
IFundForPrimaryMarketV4(fund).primaryMarketMint(TRANCHE_Q, recipient, outQ, version);
_tokenUnderlying.safeTransfer(fund, underlying);
emit Created(recipient, underlying, outQ);
}
/// @notice Redeem QUEEN and wait in the redemption queue. Redeemed underlying tokens will/// be claimable when the fund has enough balance to pay this redemption and all/// previous ones in the queue./// @param recipient Address that will receive redeemed underlying tokens/// @param inQ Spent QUEEN amount/// @param version The latest rebalance version/// @return underlying Received underlying amount, always return zero/// @return index Index of the queued redemptionfunctionqueueRedemption(address recipient,
uint256 inQ,
uint256, // minUnderlying is ignoreduint256 version
) externalnonReentrantreturns (uint256 underlying, uint256 index) {
require(inQ >= minRedemptionBound && inQ <= maxRedemptionBound, "Invalid amount");
underlying =0;
index = redemptionQueueTail;
QueuedRedemption storage newRedemption = queuedRedemptions[index];
newRedemption.amountQ = inQ;
// overflow is desired
queuedRedemptions[index +1].previousPrefixSum = newRedemption.previousPrefixSum + inQ;
redemptionQueueTail = index +1;
// Transfer QUEEN from the sender to this contract
IFundForPrimaryMarketV4(fund).primaryMarketBurn(TRANCHE_Q, msg.sender, inQ, version);
IFundForPrimaryMarketV4(fund).primaryMarketMint(TRANCHE_Q, address(this), inQ, version);
newRedemption.seed = _descriptor.generateSeed(index, inQ);
emit RedemptionQueued(recipient, index, inQ);
// Mint the redemption NFT
_safeMint(recipient, index);
}
functionfinalizeRedemptions(uint256 count) external{
require(msg.sender== IFundV4(fund).strategy(), "Only Strategy");
uint256 oldFinalizedIndex = getNextFinalizationIndex();
uint256 newFinalizedIndex = oldFinalizedIndex.add(count);
require(newFinalizedIndex <= redemptionQueueTail, "Redemption queue out of bound");
// overflow is desireduint256 amountQ =
queuedRedemptions[newFinalizedIndex].previousPrefixSum -
queuedRedemptions[oldFinalizedIndex].previousPrefixSum;
(uint256 underlying, ) = getRedemption(amountQ);
uint256 version = IFundV4(fund).getRebalanceSize();
IFundForPrimaryMarketV4(fund).primaryMarketBurn(TRANCHE_Q, address(this), amountQ, version);
IFundForPrimaryMarketV4(fund).primaryMarketAddDebtAndFee(underlying, 0);
emit Redeemed(address(0), amountQ, underlying, 0);
redemptionRates[redemptionRateSize++] = RedemptionRate({
nextIndex: newFinalizedIndex,
underlyingPerQ: underlying.divideDecimalPrecise(amountQ)
});
emit RedemptionFinalized(newFinalizedIndex, amountQ, underlying);
emit BatchMetadataUpdate(oldFinalizedIndex, newFinalizedIndex -1);
}
/// @notice Remove a given number of redemptions from the front of the redemption queue and/// fetch underlying tokens of these redemptions from the fund. Revert if the fund/// cannot pay these redemptions now./// @param count The number of redemptions to be removed, or zero to completely empty the queue/// @param rateIndexOfHead Redemption rate index of the first redemption in the queue/// (index `redemptionQueueHead`). Call `getRedemptionRateIndexOfHead()` for this value.functionpopRedemptionQueue(uint256 count, uint256 rateIndexOfHead) externalnonReentrant{
_popRedemptionQueue(count, rateIndexOfHead);
}
function_popRedemptionQueue(uint256 count, uint256 rateIndexOfHead) private{
uint256 oldHead = redemptionQueueHead;
uint256 oldTail = getNextFinalizationIndex();
uint256 newHead;
if (count ==0) {
if (oldHead == oldTail) {
return;
}
newHead = oldTail;
} else {
newHead = oldHead.add(count);
require(newHead <= oldTail, "Redemption queue out of bound");
}
require(rateIndexOfHead < redemptionRateSize, "Invalid rate index");
require(
rateIndexOfHead ==0|| oldHead >= redemptionRates[rateIndexOfHead -1].nextIndex,
"Invalid rate index"
);
require(oldHead < redemptionRates[rateIndexOfHead].nextIndex, "Invalid rate index");
uint256 startIndex = oldHead;
uint256 requiredUnderlying =0;
while (startIndex < newHead) {
uint256 nextIndex = redemptionRates[rateIndexOfHead].nextIndex;
uint256 endIndex = newHead.min(nextIndex);
requiredUnderlying = requiredUnderlying.add(
redemptionRates[rateIndexOfHead].underlyingPerQ.multiplyDecimalPrecise(
queuedRedemptions[endIndex].previousPrefixSum -
queuedRedemptions[startIndex].previousPrefixSum
) // overflow is desired
);
if (endIndex == nextIndex) {
rateIndexOfHead++;
}
startIndex = endIndex;
}
if (newHead == oldTail) {
// The fund's debt can be slightly larger than the sum of all finalized redemptions// due to rounding errors. In this case, we completely clear the debt, so that it// won't block `FundV4.applyStrategyUpdate()`.uint256 debt = IFundV4(fund).getTotalDebt();
require(debt >= requiredUnderlying);
requiredUnderlying = debt;
}
// Redundant check for user-friendly revert message.require(
requiredUnderlying <= _tokenUnderlying.balanceOf(fund),
"Not enough underlying in fund"
);
claimableUnderlying = claimableUnderlying.add(requiredUnderlying);
IFundForPrimaryMarketV4(fund).primaryMarketPayDebt(requiredUnderlying);
redemptionQueueHead = newHead;
emit RedemptionPopped(newHead - oldHead, newHead, requiredUnderlying);
}
/// @notice Claim underlying tokens of queued redemptions. All these redemptions must belong/// to msg.sender./// @param indices Indices of the redemptions in the queue, which must be in increasing order/// @param rateIndices Indices of the redemption rates, which must corrspond to the queued/// redemption indices/// @param rateIndexOfHead Redemption rate index of the first redemption in the queue/// (index `redemptionQueueHead`). Call `getRedemptionRateIndexOfHead()` for this value./// @return underlying Total claimed underlying amountfunctionclaimRedemptions(uint256[] calldata indices,
uint256[] calldata rateIndices,
uint256 rateIndexOfHead
) externalnonReentrantreturns (uint256 underlying) {
underlying = _claimRedemptions(indices, rateIndices, rateIndexOfHead);
_tokenUnderlying.safeTransfer(msg.sender, underlying);
}
/// @notice Claim native currency of queued redemptions. The underlying must be wrapped token/// of the native currency. All these redemptions must belong to msg.sender./// @param indices Indices of the redemptions in the queue, which must be in increasing order/// @param rateIndices Indices of the redemption rates, which must corrspond to the indices/// @param rateIndexOfHead Redemption rate index of the first redemption in the queue/// (index `redemptionQueueHead`). Call `getRedemptionRateIndexOfHead()` for this value./// @return underlying Total claimed underlying amountfunctionclaimRedemptionsAndUnwrap(uint256[] calldata indices,
uint256[] calldata rateIndices,
uint256 rateIndexOfHead
) externalnonReentrantreturns (uint256 underlying) {
underlying = _claimRedemptions(indices, rateIndices, rateIndexOfHead);
IWrappedERC20(address(_tokenUnderlying)).withdraw(underlying);
(bool success, ) =msg.sender.call{value: underlying}("");
require(success, "Transfer failed");
}
function_claimRedemptions(uint256[] calldata indices,
uint256[] calldata rateIndices,
uint256 rateIndexOfHead
) privatereturns (uint256 underlying) {
uint256 count = indices.length;
require(count == rateIndices.length, "Invalid rate indices");
if (count ==0) {
return0;
}
uint256 head = redemptionQueueHead;
if (indices[count -1] >= head) {
_popRedemptionQueue(indices[count -1] - head +1, rateIndexOfHead);
}
for (uint256 i =0; i < count; i++) {
require(i ==0|| indices[i] > indices[i -1], "Indices out of order");
require(rateIndices[i] < redemptionRateSize, "Invalid rate index");
// redemptionRates[rateIndices[i] - 1].nextIndex == 0 if rateIndices[i] == 0require(
indices[i] < redemptionRates[rateIndices[i]].nextIndex &&
indices[i] >= redemptionRates[rateIndices[i] -1].nextIndex,
"Invalid index"
);
QueuedRedemption storage redemption = queuedRedemptions[indices[i]];
uint256 redemptionUnderlying =
redemption.amountQ.multiplyDecimalPrecise(
redemptionRates[rateIndices[i]].underlyingPerQ
);
require(
ownerOf(indices[i]) ==msg.sender&& redemption.amountQ !=0,
"Invalid redemption index"
);
underlying = underlying.add(redemptionUnderlying);
emit RedemptionClaimed(msg.sender, indices[i], redemptionUnderlying);
delete queuedRedemptions[indices[i]];
_burn(indices[i]);
}
claimableUnderlying = claimableUnderlying.sub(underlying);
}
functionsplit(address recipient,
uint256 inQ,
uint256 version
) externalreturns (uint256 outB) {
outB = getSplit(inQ);
IFundForPrimaryMarketV4(fund).primaryMarketBurn(TRANCHE_Q, msg.sender, inQ, version);
IFundForPrimaryMarketV4(fund).primaryMarketMint(TRANCHE_B, recipient, outB, version);
IFundForPrimaryMarketV4(fund).primaryMarketMint(TRANCHE_R, recipient, outB, version);
emit Split(recipient, inQ, outB, outB);
}
functionmerge(address recipient,
uint256 inB,
uint256 version
) externalreturns (uint256 outQ) {
uint256 feeQ;
(outQ, feeQ) = getMerge(inB);
IFundForPrimaryMarketV4(fund).primaryMarketBurn(TRANCHE_B, msg.sender, inB, version);
IFundForPrimaryMarketV4(fund).primaryMarketBurn(TRANCHE_R, msg.sender, inB, version);
IFundForPrimaryMarketV4(fund).primaryMarketMint(TRANCHE_Q, recipient, outQ, version);
IFundForPrimaryMarketV4(fund).primaryMarketAddDebtAndFee(0, feeQ);
emit Merged(recipient, outQ, inB, inB, feeQ);
}
/// @dev Nothing to do for daily fund settlement.functionsettle(uint256 day) externalonlyFund{}
function_updateFundCap(uint256 newCap) private{
fundCap = newCap;
emit FundCapUpdated(newCap);
}
functionupdateFundCap(uint256 newCap) externalonlyOwner{
_updateFundCap(newCap);
}
function_updateMergeFeeRate(uint256 newMergeFeeRate) private{
require(newMergeFeeRate <= MAX_MERGE_FEE_RATE, "Exceed max merge fee rate");
mergeFeeRate = newMergeFeeRate;
emit MergeFeeRateUpdated(newMergeFeeRate);
}
functionupdateMergeFeeRate(uint256 newMergeFeeRate) externalonlyOwner{
_updateMergeFeeRate(newMergeFeeRate);
}
function_updateRedemptionBounds(uint256 newMinRedemptionBound, uint256 newMaxRedemptionBound)
private{
require(newMinRedemptionBound <= newMaxRedemptionBound, "Invalid redemption bounds");
minRedemptionBound = newMinRedemptionBound;
maxRedemptionBound = newMaxRedemptionBound;
emit RedemptionBoundsUpdated(newMinRedemptionBound, newMaxRedemptionBound);
}
functionupdateRedemptionBounds(uint256 newMinRedemptionBound, uint256 newMaxRedemptionBound)
externalonlyOwner{
_updateRedemptionBounds(newMinRedemptionBound, newMaxRedemptionBound);
}
/// @notice Receive unwrapped transfer from the wrapped token.receive() externalpayable{}
modifieronlyFund() {
require(msg.sender== fund, "Only fund");
_;
}
}
Contract Source Code
File 8 of 27: IERC165.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <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}.
*/interfaceIERC165{
/**
* @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.
*/functionsupportsInterface(bytes4 interfaceId) externalviewreturns (bool);
}
Contract Source Code
File 9 of 27: IERC20.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/interfaceIERC20{
/**
* @dev Returns the amount of tokens in existence.
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/functionbalanceOf(address account) externalviewreturns (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.
*/functiontransfer(address recipient, uint256 amount) externalreturns (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.
*/functionallowance(address owner, address spender) externalviewreturns (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.
*/functionapprove(address spender, uint256 amount) externalreturns (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.
*/functiontransferFrom(address sender, address recipient, uint256 amount) externalreturns (bool);
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/eventTransfer(addressindexedfrom, addressindexed 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.
*/eventApproval(addressindexed owner, addressindexed spender, uint256 value);
}
Contract Source Code
File 10 of 27: IERC721.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.2 <0.8.0;import"../../introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/interfaceIERC721isIERC165{
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/eventTransfer(addressindexedfrom, addressindexed to, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/eventApproval(addressindexed owner, addressindexed approved, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/eventApprovalForAll(addressindexed owner, addressindexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/functionbalanceOf(address owner) externalviewreturns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functionownerOf(uint256 tokenId) externalviewreturns (address owner);
/**
* @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.
*/functionsafeTransferFrom(addressfrom, 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.
*/functiontransferFrom(addressfrom, 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.
*/functionapprove(address to, uint256 tokenId) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functiongetApproved(uint256 tokenId) externalviewreturns (address operator);
/**
* @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.
*/functionsetApprovalForAll(address operator, bool _approved) external;
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/functionisApprovedForAll(address owner, address operator) externalviewreturns (bool);
/**
* @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.
*/functionsafeTransferFrom(addressfrom, address to, uint256 tokenId, bytescalldata data) external;
}
Contract Source Code
File 11 of 27: IERC721Enumerable.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.2 <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
*/interfaceIERC721EnumerableisIERC721{
/**
* @dev Returns the total amount of tokens stored by the contract.
*/functiontotalSupply() externalviewreturns (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.
*/functiontokenOfOwnerByIndex(address owner, uint256 index) externalviewreturns (uint256 tokenId);
/**
* @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.
*/functiontokenByIndex(uint256 index) externalviewreturns (uint256);
}
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @title ERC721 token receiver interface
* @dev Interface for any contract that wants to support safeTransfers
* from ERC721 asset contracts.
*/interfaceIERC721Receiver{
/**
* @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 `IERC721.onERC721Received.selector`.
*/functiononERC721Received(address operator, addressfrom, uint256 tokenId, bytescalldata data) externalreturns (bytes4);
}
// SPDX-License-Identifier: GPL-3.0-or-laterpragmasolidity >=0.6.10 <0.8.0;/// @notice Amounts of QUEEN, BISHOP and ROOK are sometimes stored in a `uint256[3]` array./// This contract defines index of each tranche in this array.////// Solidity does not allow constants to be defined in interfaces. So this contract follows/// the naming convention of interfaces but is implemented as an `abstract contract`.abstractcontractITrancheIndexV2{
uint256internalconstant TRANCHE_Q =0;
uint256internalconstant TRANCHE_B =1;
uint256internalconstant TRANCHE_R =2;
uint256internalconstant TRANCHE_COUNT =3;
}
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @dev Standard math utilities missing in the Solidity language.
*/libraryMath{
/**
* @dev Returns the largest of two numbers.
*/functionmax(uint256 a, uint256 b) internalpurereturns (uint256) {
return a >= b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/functionmin(uint256 a, uint256 b) internalpurereturns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/functionaverage(uint256 a, uint256 b) internalpurereturns (uint256) {
// (a + b) / 2 can overflow, so we distributereturn (a /2) + (b /2) + ((a %2+ b %2) /2);
}
}
Contract Source Code
File 22 of 27: Ownable.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;import"../utils/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.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/constructor () internal{
address msgSender = _msgSender();
_owner = msgSender;
emit OwnershipTransferred(address(0), msgSender);
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
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.
*/functionrenounceOwnership() publicvirtualonlyOwner{
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.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
require(newOwner !=address(0), "Ownable: new owner is the zero address");
emit OwnershipTransferred(_owner, newOwner);
_owner = newOwner;
}
}
Contract Source Code
File 23 of 27: ReentrancyGuard.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/abstractcontractReentrancyGuard{
// Booleans are more expensive than uint256 or any type that takes up a full// word because each write operation emits an extra SLOAD to first read the// slot's contents, replace the bits taken up by the boolean, and then write// back. This is the compiler's defense against contract upgrades and// pointer aliasing, and it cannot be disabled.// The values being non-zero value makes deployment a bit more expensive,// but in exchange the refund on every call to nonReentrant will be lower in// amount. Since refunds are capped to a percentage of the total// transaction's gas, it is best to keep them low in cases like this one, to// increase the likelihood of the full refund coming into effect.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _status;
constructor () internal{
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and make it call a
* `private` function that does the actual work.
*/modifiernonReentrant() {
// On the first call to nonReentrant, _notEntered will be truerequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
Contract Source Code
File 24 of 27: SafeDecimalMath.sol
// SPDX-License-Identifier: MIT//// Copyright (c) 2019 Synthetix//// Permission is hereby granted, free of charge, to any person obtaining a copy// of this software and associated documentation files (the "Software"), to deal// in the Software without restriction, including without limitation the rights// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell// copies of the Software, and to permit persons to whom the Software is// furnished to do so, subject to the following conditions://// The above copyright notice and this permission notice shall be included in all// copies or substantial portions of the Software.//// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE// SOFTWARE.pragmasolidity >=0.6.10 <0.8.0;import"@openzeppelin/contracts/math/SafeMath.sol";
librarySafeDecimalMath{
usingSafeMathforuint256;
/* Number of decimal places in the representations. */uint256privateconstant decimals =18;
uint256privateconstant highPrecisionDecimals =27;
/* The number representing 1.0. */uint256privateconstant UNIT =10**uint256(decimals);
/* The number representing 1.0 for higher fidelity numbers. */uint256privateconstant PRECISE_UNIT =10**uint256(highPrecisionDecimals);
uint256privateconstant UNIT_TO_HIGH_PRECISION_CONVERSION_FACTOR =10**uint256(highPrecisionDecimals - decimals);
/**
* @return The result of multiplying x and y, interpreting the operands as fixed-point
* decimals.
*
* @dev A unit factor is divided out after the product of x and y is evaluated,
* so that product must be less than 2**256. As this is an integer division,
* the internal division always rounds down. This helps save on gas. Rounding
* is more expensive on gas.
*/functionmultiplyDecimal(uint256 x, uint256 y) internalpurereturns (uint256) {
/* Divide by UNIT to remove the extra factor introduced by the product. */return x.mul(y).div(UNIT);
}
functionmultiplyDecimalPrecise(uint256 x, uint256 y) internalpurereturns (uint256) {
/* Divide by UNIT to remove the extra factor introduced by the product. */return x.mul(y).div(PRECISE_UNIT);
}
/**
* @return The result of safely dividing x and y. The return value is a high
* precision decimal.
*
* @dev y is divided after the product of x and the standard precision unit
* is evaluated, so the product of x and UNIT must be less than 2**256. As
* this is an integer division, the result is always rounded down.
* This helps save on gas. Rounding is more expensive on gas.
*/functiondivideDecimal(uint256 x, uint256 y) internalpurereturns (uint256) {
/* Reintroduce the UNIT factor that will be divided out by y. */return x.mul(UNIT).div(y);
}
functiondivideDecimalPrecise(uint256 x, uint256 y) internalpurereturns (uint256) {
/* Reintroduce the UNIT factor that will be divided out by y. */return x.mul(PRECISE_UNIT).div(y);
}
/**
* @dev Convert a standard decimal representation to a high precision one.
*/functiondecimalToPreciseDecimal(uint256 i) internalpurereturns (uint256) {
return i.mul(UNIT_TO_HIGH_PRECISION_CONVERSION_FACTOR);
}
/**
* @dev Convert a high precision decimal to a standard decimal representation.
*/functionpreciseDecimalToDecimal(uint256 i) internalpurereturns (uint256) {
uint256 quotientTimesTen = i.mul(10).div(UNIT_TO_HIGH_PRECISION_CONVERSION_FACTOR);
if (quotientTimesTen %10>=5) {
quotientTimesTen = quotientTimesTen.add(10);
}
return quotientTimesTen.div(10);
}
/**
* @dev Returns the multiplication of two unsigned integers, and the max value of
* uint256 on overflow.
*/functionsaturatingMul(uint256 a, uint256 b) internalpurereturns (uint256) {
if (a ==0) {
return0;
}
uint256 c = a * b;
return c / a != b ? type(uint256).max : c;
}
functionsaturatingMultiplyDecimal(uint256 x, uint256 y) internalpurereturns (uint256) {
/* Divide by UNIT to remove the extra factor introduced by the product. */return saturatingMul(x, y).div(UNIT);
}
}
Contract Source Code
File 25 of 27: SafeERC20.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;import"./IERC20.sol";
import"../../math/SafeMath.sol";
import"../../utils/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.
*/librarySafeERC20{
usingSafeMathforuint256;
usingAddressforaddress;
functionsafeTransfer(IERC20 token, address to, uint256 value) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
functionsafeTransferFrom(IERC20 token, addressfrom, 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.
*/functionsafeApprove(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'// solhint-disable-next-line max-line-lengthrequire((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));
}
functionsafeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal{
uint256 newAllowance = token.allowance(address(this), spender).add(value);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
functionsafeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal{
uint256 newAllowance = token.allowance(address(this), spender).sub(value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
/**
* @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, bytesmemory 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.bytesmemory returndata =address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length>0) { // Return data is optional// solhint-disable-next-line max-line-lengthrequire(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
Contract Source Code
File 26 of 27: SafeMath.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @dev Wrappers over Solidity's arithmetic operations with added overflow
* checks.
*
* Arithmetic operations in Solidity wrap on overflow. This can easily result
* in bugs, because programmers usually assume that an overflow raises an
* error, which is the standard behavior in high level programming languages.
* `SafeMath` restores this intuition by reverting the transaction when 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.
*/librarySafeMath{
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/functiontryAdd(uint256 a, uint256 b) internalpurereturns (bool, uint256) {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
/**
* @dev Returns the substraction of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/functiontrySub(uint256 a, uint256 b) internalpurereturns (bool, uint256) {
if (b > a) return (false, 0);
return (true, a - b);
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/functiontryMul(uint256 a, uint256 b) internalpurereturns (bool, uint256) {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the// benefit is lost if 'b' is also tested.// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522if (a ==0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/functiontryDiv(uint256 a, uint256 b) internalpurereturns (bool, uint256) {
if (b ==0) return (false, 0);
return (true, a / b);
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/functiontryMod(uint256 a, uint256 b) internalpurereturns (bool, uint256) {
if (b ==0) return (false, 0);
return (true, a % b);
}
/**
* @dev Returns the addition of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
*
* - Addition cannot overflow.
*/functionadd(uint256 a, uint256 b) internalpurereturns (uint256) {
uint256 c = a + b;
require(c >= a, "SafeMath: addition overflow");
return c;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/functionsub(uint256 a, uint256 b) internalpurereturns (uint256) {
require(b <= a, "SafeMath: subtraction overflow");
return a - b;
}
/**
* @dev Returns the multiplication of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
*
* - Multiplication cannot overflow.
*/functionmul(uint256 a, uint256 b) internalpurereturns (uint256) {
if (a ==0) return0;
uint256 c = a * b;
require(c / a == b, "SafeMath: multiplication overflow");
return c;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/functiondiv(uint256 a, uint256 b) internalpurereturns (uint256) {
require(b >0, "SafeMath: division by zero");
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/functionmod(uint256 a, uint256 b) internalpurereturns (uint256) {
require(b >0, "SafeMath: modulo by zero");
return a % b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {trySub}.
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/functionsub(uint256 a, uint256 b, stringmemory errorMessage) internalpurereturns (uint256) {
require(b <= a, errorMessage);
return a - b;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting with custom message on
* division by zero. The result is rounded towards zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryDiv}.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/functiondiv(uint256 a, uint256 b, stringmemory errorMessage) internalpurereturns (uint256) {
require(b >0, errorMessage);
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting with custom message when dividing by zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryMod}.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/functionmod(uint256 a, uint256 b, stringmemory errorMessage) internalpurereturns (uint256) {
require(b >0, errorMessage);
return a % b;
}
}
Contract Source Code
File 27 of 27: Strings.sol
// SPDX-License-Identifier: MITpragmasolidity >=0.6.0 <0.8.0;/**
* @dev String operations.
*/libraryStrings{
/**
* @dev Converts a `uint256` to its ASCII `string` representation.
*/functiontoString(uint256 value) internalpurereturns (stringmemory) {
// Inspired by OraclizeAPI's implementation - MIT licence// https://github.com/oraclize/ethereum-api/blob/b42146b063c7d6ee1358846c198246239e9360e8/oraclizeAPI_0.4.25.solif (value ==0) {
return"0";
}
uint256 temp = value;
uint256 digits;
while (temp !=0) {
digits++;
temp /=10;
}
bytesmemory buffer =newbytes(digits);
uint256 index = digits -1;
temp = value;
while (temp !=0) {
buffer[index--] =bytes1(uint8(48+ temp %10));
temp /=10;
}
returnstring(buffer);
}
}