// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.5.0) (utils/Address.sol)pragmasolidity ^0.8.1;/**
* @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
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/functionisContract(address account) internalviewreturns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0// for contracts in construction, since the code is only stored at the end// of the constructor execution.return account.code.length>0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/functionsendValue(addresspayable recipient, uint256 amount) internal{
require(address(this).balance>= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/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");
(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");
(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");
(bool success, bytesmemory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason using the provided one.
*
* _Available since v4.3._
*/functionverifyCallResult(bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalpurereturns (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 assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
Contract Source Code
File 2 of 19: CapsuleToken.sol
// SPDX-License-Identifier: GPL-3.0/**
@title CapsuleToken
@author peri
@notice Each Capsule token has a unique color and text rendered in the Capsules Typeface as a SVG. Text and font for a Capsule can be updated anytime by its owner.
@dev `bytes3` type is used to store the RGB hex-encoded color that is unique to each Capsule.
`bytes32[8]` type is used to store 8 lines of 16 text characters, where each line contains 16 2-byte unicodes packed into a bytes32 value. 2 bytes is large enough to encode the unicode for every character in the Basic Multilingual Plane (BMP).
To avoid high gas costs, text isn't validated when minting or editing, meaning Capsule text could contain characters that are unsupported by the Capsules Typeface. Instead, we rely on the Renderer contract to render a safe image even if the Capsule text is invalid.
Capsules will use the default Renderer contract to render images unless the owner has set a valid renderer for that Capsule.
Token metadata for all Capsules is rendered by the upgradeable Metadata contract.
*/pragmasolidity ^0.8.8;import"@openzeppelin/contracts/access/Ownable.sol";
import"@openzeppelin/contracts/interfaces/IERC2981.sol";
import"@openzeppelin/contracts/security/ReentrancyGuard.sol";
import"@openzeppelin/contracts/security/Pausable.sol";
import"./ERC721A.sol";
import"./interfaces/ICapsuleMetadata.sol";
import"./interfaces/ICapsuleRenderer.sol";
import"./interfaces/ICapsuleToken.sol";
import"./interfaces/ITypeface.sol";
/* *//* 000 000 0000 0000 0 0 0 00000 0000 *//* 0 0 0 0 0 0 0 0 0 0 0 0 *//* 0 00000 0000 000 0 0 0 0000 000 *//* 0 0 0 0 0 0 0 0 0 0 0 *//* 000 0 0 0 0000 000 00000 00000 0000 *//* */errorColorAlreadyMinted(uint256 capsuleId);
errorInvalidColor();
errorInvalidFontForRenderer(address renderer);
errorInvalidRenderer();
errorNoGiftAvailable();
errorNotCapsuleOwner(address owner);
errorNotCapsulesTypeface();
errorPureColorNotAllowed();
errorValueBelowMintPrice();
contractCapsuleTokenisICapsuleToken,
ERC721A,
IERC2981,
Ownable,
Pausable,
ReentrancyGuard{
/* -------------------------------------------------------------------------- *//* 0 0 000 0000 00000 00000 00000 00000 0000 0000 *//* 00 00 0 0 0 0 0 0 0 0 0 0 0 *//* 0 0 0 0 0 0 0 0 00000 0 00000 0000 000 *//* 0 0 0 0 0 0 0 0 0 0 0 0 0 *//* 0 0 000 0000 00000 0 00000 00000 0 0 0000 *//* -------------------------------------------------------------------------- *//* -------------------------------- MODIFIERS ------------------------------- *//* -------------------------------------------------------------------------- *//// @notice Require that the value sent is at least MINT_PRICE.modifierrequireMintPrice() {
if (msg.value< MINT_PRICE) revert ValueBelowMintPrice();
_;
}
/// @notice Require that the gift count of sender is greater than 0.modifierrequireGift() {
if (giftCountOf(msg.sender) ==0) revert NoGiftAvailable();
_;
}
/// @notice Require that the font is valid for a given renderer.modifieronlyValidFontForRenderer(Font memory font, address renderer) {
if (!isValidFontForRenderer(font, renderer))
revert InvalidFontForRenderer(renderer);
_;
}
/// @notice Require that the font is valid for a given renderer.modifieronlyValidRenderer(address renderer) {
if (!isValidRenderer(renderer)) revert InvalidRenderer();
_;
}
/// @notice Require that the color is valid and unminted.modifieronlyMintableColor(bytes3 color) {
uint256 capsuleId = tokenIdOfColor[color];
if (_exists(capsuleId)) revert ColorAlreadyMinted(capsuleId);
if (!isValidColor(color)) revert InvalidColor();
_;
}
/// @notice Require that the color is not pure.modifieronlyImpureColor(bytes3 color) {
if (isPureColor(color)) revert PureColorNotAllowed();
_;
}
/// @notice Require that the sender is the CapsulesTypeface contract.modifieronlyCapsulesTypeface() {
if (msg.sender!= capsulesTypeface) revert NotCapsulesTypeface();
_;
}
/// @notice Require that the sender owns the Capsule.modifieronlyCapsuleOwner(uint256 capsuleId) {
address owner = ownerOf(capsuleId);
if (owner !=msg.sender) revert NotCapsuleOwner(owner);
_;
}
/* -------------------------------------------------------------------------- *//* 000 000 0 0 0000 00000 0000 0 0 000 00000 000 0000 *//* 0 0 0 0 00 0 0 0 0 0 0 0 0 0 0 0 0 0 0 *//* 0 0 0 0 0 0 000 0 0000 0 0 0 0 0 0 0000 *//* 0 0 0 0 0 00 0 0 0 0 0 0 0 0 0 0 0 0 0 *//* 000 000 0 0 0000 0 0 0 000 000 0 000 0 0 *//* -------------------------------------------------------------------------- *//* ------------------------------- CONSTRUCTOR ------------------------------ *//* -------------------------------------------------------------------------- */constructor(address _capsulesTypeface,
address _defaultRenderer,
address _capsuleMetadata,
address _feeReceiver,
bytes3[] memory _pureColors,
uint256 _royalty
) ERC721A("Capsules", "CAPS") {
capsulesTypeface = _capsulesTypeface;
_setDefaultRenderer(_defaultRenderer);
_setMetadata(_capsuleMetadata);
_setFeeReceiver(_feeReceiver);
pureColors = _pureColors;
emit SetPureColors(_pureColors);
_setRoyalty(_royalty);
_pause();
}
/* -------------------------------------------------------------------------- *//* 0 0 000 0000 00000 000 0000 0 00000 0000 *//* 0 0 0 0 0 0 0 0 0 0 0 0 0 0 *//* 0 0 00000 0000 0 00000 0000 0 0000 000 *//* 0 0 0 0 0 0 0 0 0 0 0 0 0 0 *//* 0 0 0 0 0 00000 0 0 0000 00000 00000 0000 *//* -------------------------------------------------------------------------- *//* -------------------------------- VARIABLES ------------------------------- *//* -------------------------------------------------------------------------- *//// Price to mint a Capsuleuint256publicconstant MINT_PRICE =1e16; // 0.01 ETH/// CapsulesTypeface addressaddresspublicimmutable capsulesTypeface;
/// Default CapsuleRenderer addressaddresspublic defaultRenderer;
/// CapsuleMetadata addressaddresspublic capsuleMetadata;
/// Capsule ID of a minted colormapping(bytes3=>uint256) public tokenIdOfColor;
/// Array of pure colorsbytes3[] public pureColors;
/// Address to receive mint and royalty feesaddresspublic feeReceiver;
/// Royalty amount out of 1000uint256public royalty;
/// Validity of a renderer addressmapping(address=>bool) internal _validRenderers;
/// Text of a Capsule IDmapping(uint256=>bytes32[8]) internal _textOf;
/// Color of a Capsule IDmapping(uint256=>bytes3) internal _colorOf;
/// Font of a Capsule IDmapping(uint256=> Font) internal _fontOf;
/// Renderer address of a Capsule IDmapping(uint256=>address) internal _rendererOf;
/// Numer of gift mints for addressesmapping(address=>uint256) internal _giftCount;
/// Contract URIstringinternal _contractURI;
/* -------------------------------------------------------------------------- *//* 00000 0 0 00000 00000 0000 0 0 000 0 *//* 0 0 0 0 0 0 0 00 0 0 0 0 *//* 0000 0 0 0000 0000 0 0 0 00000 0 *//* 0 0 0 0 0 0 0 0 00 0 0 0 *//* 00000 0 0 0 00000 0 0 0 0 0 0 00000 *//* -------------------------------------------------------------------------- *//* --------------------------- EXTERNAL FUNCTIONS --------------------------- *//* -------------------------------------------------------------------------- *//// @notice Mints a Capsule to sender, saving gas by not setting text./// @param color Color of Capsule./// @param font Font of Capsule./// @return capsuleId ID of minted Capsule.functionmint(bytes3 color,
Font calldata font,
bytes32[8] calldata text
)
externalpayablewhenNotPausedrequireMintPriceonlyImpureColor(color)
nonReentrantreturns (uint256)
{
return _mintCapsule(msg.sender, color, font, text);
}
/// @notice Mints a Capsule to sender, saving gas by not setting text./// @param color Color of Capsule./// @param font Font of Capsule./// @return capsuleId ID of minted Capsule.functionmintGift(bytes3 color,
Font calldata font,
bytes32[8] calldata text
)
externalwhenNotPausedrequireGiftonlyImpureColor(color)
nonReentrantreturns (uint256 capsuleId)
{
_giftCount[msg.sender]--;
capsuleId = _mintCapsule(msg.sender, color, font, text);
emit MintGift(msg.sender);
}
/// @notice Allows the CapsulesTypeface to mint a pure color Capsule./// @dev _mintCapsule checks that font is valid for default renderer. Font will be valid as its source was stored earlier in this transaction./// @param to Address to receive Capsule./// @param font Font of Capsule./// @return capsuleId ID of minted Capsule.functionmintPureColorForFont(address to, Font calldata font)
externalwhenNotPausedonlyCapsulesTypefacenonReentrantreturns (uint256)
{
bytes32[8] memory text;
return
_mintCapsule(to, pureColorForFontWeight(font.weight), font, text);
}
/// @notice Return token URI for Capsule, using the CapsuleMetadata contract./// @param capsuleId ID of Capsule token./// @return metadata Metadata string for Capsule.functiontokenURI(uint256 capsuleId)
publicviewoverridereturns (stringmemory)
{
require(_exists(capsuleId), "ERC721A: URI query for nonexistent token");
return
ICapsuleMetadata(capsuleMetadata).metadataOf(
capsuleOf(capsuleId),
svgOf(capsuleId)
);
}
/// @notice Return contractURI./// @return contractURI contractURIfunctioncontractURI() publicviewreturns (stringmemory) {
return _contractURI;
}
/// @notice Return SVG image from the Capsule's renderer./// @param capsuleId ID of Capsule token./// @return svg Encoded SVG image of Capsule.functionsvgOf(uint256 capsuleId) publicviewreturns (stringmemory) {
return
ICapsuleRenderer(rendererOf(capsuleId)).svgOf(capsuleOf(capsuleId));
}
/// @notice Returns all data for Capsule./// @param capsuleId ID of Capsule./// @return capsule Data for Capsule.functioncapsuleOf(uint256 capsuleId) publicviewreturns (Capsule memory) {
bytes3 color = _colorOf[capsuleId];
return
Capsule({
id: capsuleId,
font: _fontOf[capsuleId],
text: _textOf[capsuleId],
color: color,
isPure: isPureColor(color)
});
}
/// @notice Check if color is pure./// @param color Color to check./// @return true True if color is pure.functionisPureColor(bytes3 color) publicviewreturns (bool) {
bytes3[] memory _pureColors = pureColors;
unchecked {
for (uint256 i; i < _pureColors.length; i++) {
if (color == _pureColors[i]) returntrue;
}
}
returnfalse;
}
/// @notice Returns the gift count of an address./// @param a Address to check gift count of./// @return count Gift count for address.functiongiftCountOf(address a) publicviewreturns (uint256) {
return _giftCount[a];
}
/// @notice Returns the color of a Capsule./// @param capsuleId ID of Capsule./// @return color Color of Capsule.functioncolorOf(uint256 capsuleId) publicviewreturns (bytes3) {
return _colorOf[capsuleId];
}
/// @notice Returns the text of a Capsule./// @param capsuleId ID of Capsule./// @return text Text of Capsule.functiontextOf(uint256 capsuleId) publicviewreturns (bytes32[8] memory) {
return _textOf[capsuleId];
}
/// @notice Returns the font of a Capsule./// @param capsuleId ID of Capsule./// @return font Font of Capsule.functionfontOf(uint256 capsuleId) publicviewreturns (Font memory) {
return _fontOf[capsuleId];
}
/// @notice Returns renderer of a Capsule. If the Capsule has no renderer set, the default renderer is used./// @param capsuleId ID of Capsule./// @return renderer Address of renderer.functionrendererOf(uint256 capsuleId) publicviewreturns (address) {
if (_rendererOf[capsuleId] !=address(0)) return _rendererOf[capsuleId];
return defaultRenderer;
}
/// @notice Check if font is valid for a Renderer contract./// @param renderer Renderer contract address./// @param font Font to check validity of./// @return true True if font is valid.functionisValidFontForRenderer(Font memory font, address renderer)
publicviewreturns (bool)
{
return ICapsuleRenderer(renderer).isValidFont(font);
}
/// @notice Check if address is a valid CapsuleRenderer contract./// @param renderer Renderer address to check./// @return true True if renderer is valid.functionisValidRenderer(address renderer) publicviewreturns (bool) {
return _validRenderers[renderer];
}
/// @notice Check if color is valid./// @dev A color is valid if all 3 bytes are divisible by 5 AND at least one byte == 255./// @param color Color to check validity of./// @return true True if color is valid.functionisValidColor(bytes3 color) publicpurereturns (bool) {
// At least one byte must equal 0xff (255)if (color[0] <0xff&& color[1] <0xff&& color[2] <0xff) {
returnfalse;
}
// All bytes must be divisible by 5unchecked {
for (uint256 i; i <3; i++) {
if (uint8(color[i]) %5!=0) returnfalse;
}
}
returntrue;
}
/// @notice Check if Capsule text is valid./// @dev Checks validity using Capsule's renderer contract./// @param capsuleId ID of Capsule./// @return true True if Capsule text is valid.functionisValidCapsuleText(uint256 capsuleId)
externalviewreturns (bool)
{
return
ICapsuleRenderer(rendererOf(capsuleId)).isValidText(
textOf(capsuleId)
);
}
/// @notice Withdraws balance of this contract to the feeReceiver address.functionwithdraw() externalnonReentrant{
uint256 balance =address(this).balance;
payable(feeReceiver).transfer(balance);
emit Withdraw(feeReceiver, balance);
}
/// @notice EIP2981 royalty standardfunctionroyaltyInfo(uint256, uint256 salePrice)
externalviewreturns (address receiver, uint256 royaltyAmount)
{
return (feeReceiver, (salePrice * royalty) /1000);
}
/// @notice EIP2981 standard Interface return. Adds to ERC721A Interface returns./// @dev See {IERC165-supportsInterface}.functionsupportsInterface(bytes4 interfaceId)
publicviewvirtualoverride(IERC165, ERC721A)
returns (bool)
{
return
interfaceId ==type(IERC2981).interfaceId||super.supportsInterface(interfaceId);
}
/// @dev Allows contract to receive ETHreceive() externalpayable{}
/* -------------------------------------------------------------------------- *//* 000 0 0 0 0 00000 0000 *//* 0 0 0 0 00 0 0 0 0 *//* 0 0 0 0 0 0 0 0000 0000 *//* 0 0 0 0 0 0 00 0 0 0 *//* 000 0 0 0 0 00000 0 0 *//* -------------------------------------------------------------------------- *//* ------------------------ CAPSULE OWNER FUNCTIONS ------------------------- *//* -------------------------------------------------------------------------- *//// @notice Allows Capsule owner to set the Capsule text and font./// @param capsuleId ID of Capsule./// @param text New text for Capsule./// @param font New font for Capsule.functionsetTextAndFont(uint256 capsuleId,
bytes32[8] calldata text,
Font calldata font
) external{
_setText(capsuleId, text);
_setFont(capsuleId, font);
}
/// @notice Allows Capsule owner to set the Capsule text./// @param capsuleId ID of Capsule./// @param text New text for Capsule.functionsetText(uint256 capsuleId, bytes32[8] calldata text) external{
_setText(capsuleId, text);
}
/// @notice Allows Capsule owner to set the Capsule font./// @param capsuleId ID of Capsule./// @param font New font for Capsule.functionsetFont(uint256 capsuleId, Font calldata font) external{
_setFont(capsuleId, font);
}
/// @notice Allows Capsule owner to set its renderer contract. If renderer is the zero address, the Capsule will use the default renderer./// @dev Does not check validity of the current Capsule text or font with the new renderer./// @param capsuleId ID of Capsule./// @param renderer Address of new renderer.functionsetRendererOf(uint256 capsuleId, address renderer)
externalonlyCapsuleOwner(capsuleId)
onlyValidRenderer(renderer)
{
_rendererOf[capsuleId] = renderer;
emit SetCapsuleRenderer(capsuleId, renderer);
}
/// @notice Burns a Capsule./// @param capsuleId ID of Capsule to burn.functionburn(uint256 capsuleId) externalonlyCapsuleOwner(capsuleId) {
_burn(capsuleId);
}
/* -------------------------------------------------------------------------- *//* 000 0000 0 0 00000 0 0 *//* 0 0 0 0 00 00 0 00 0 *//* 00000 0 0 0 0 0 0 0 0 0 *//* 0 0 0 0 0 0 0 0 00 *//* 0 0 0000 0 0 00000 0 0 *//* -------------------------------------------------------------------------- *//* ---------------------------- ADMIN FUNCTIONS ----------------------------- *//* -------------------------------------------------------------------------- *//// @notice Mints a Capsule to sender, saving gas by not setting text./// @param to Color of Capsule./// @param color Color of Capsule./// @param font Font of Capsule./// @return capsuleId ID of minted Capsule.functionmintAsOwner(address to,
bytes3 color,
Font calldata font,
bytes32[8] calldata text
)
externalpayableonlyOwneronlyImpureColor(color)
nonReentrantreturns (uint256)
{
return _mintCapsule(to, color, font, text);
}
/// @notice Allows the owner of this contract to set the gift count of multiple addresses./// @param addresses Addresses to set gift count for./// @param counts Counts to set for addresses.functionsetGiftCounts(address[] calldata addresses,
uint256[] calldata counts
) externalonlyOwner{
if (addresses.length!= counts.length) {
revert("Number of addresses must equal number of gift counts.");
}
for (uint256 i; i < addresses.length; i++) {
address a = addresses[i];
uint256 count = counts[i];
_giftCount[a] = count;
emit SetGiftCount(a, count);
}
}
/// @notice Allows the owner of this contract to update the default renderer contract./// @param renderer Address of new default renderer contract.functionsetDefaultRenderer(address renderer) externalonlyOwner{
_setDefaultRenderer(renderer);
}
/// @notice Allows the owner of this contract to add a valid renderer contract./// @param renderer Address of renderer contract.functionaddValidRenderer(address renderer) externalonlyOwner{
_addValidRenderer(renderer);
}
/// @notice Allows the owner of this contract to update the metadata contract./// @param _capsuleMetadata Address of new default metadata contract.functionsetCapsuleMetadata(address _capsuleMetadata) externalonlyOwner{
_setMetadata(_capsuleMetadata);
}
/// @notice Allows the owner of this contract to update the contractURI./// @param __contractURI New contractURI.functionsetContractURI(stringcalldata __contractURI) externalonlyOwner{
_setContractURI(__contractURI);
}
/// @notice Allows the owner of this contract to update the feeReceiver address./// @param newFeeReceiver Address of new feeReceiver.functionsetFeeReceiver(address newFeeReceiver) externalonlyOwner{
_setFeeReceiver(newFeeReceiver);
}
/// @notice Allows the owner of this contract to update the royalty amount./// @param royaltyAmount New royalty amount.functionsetRoyalty(uint256 royaltyAmount) externalonlyOwner{
_setRoyalty(royaltyAmount);
}
/// @notice Allows the contract owner to pause the contract./// @dev Can only be called by the owner when the contract is unpaused.functionpause() externaloverrideonlyOwner{
_pause();
}
/// @notice Allows the contract owner to unpause the contract./// @dev Can only be called by the owner when the contract is paused.functionunpause() externaloverrideonlyOwner{
_unpause();
}
/* -------------------------------------------------------------------------- *//* 00000 0 0 00000 00000 0000 0 0 000 0 *//* 0 00 0 0 0 0 0 00 0 0 0 0 *//* 0 0 0 0 0 0000 0000 0 0 0 00000 0 *//* 0 0 00 0 0 0 0 0 00 0 0 0 *//* 00000 0 0 0 00000 0 0 0 0 0 0 00000 *//* -------------------------------------------------------------------------- *//* --------------------------- INTERNAL FUNCTIONS --------------------------- *//* -------------------------------------------------------------------------- *//// @notice ERC721A override to start tokenId at 1 instead of 0.function_startTokenId() internalpureoverridereturns (uint256) {
return1;
}
/// @notice Mints a Capsule./// @param to Address to receive capsule./// @param color Color of Capsule./// @param font Font of Capsule./// @return capsuleId ID of minted Capsule.function_mintCapsule(address to,
bytes3 color,
Font calldata font,
bytes32[8] memory text
)
internalonlyMintableColor(color)
onlyValidFontForRenderer(font, defaultRenderer)
returns (uint256 capsuleId)
{
_mint(to, 1, newbytes(0), false);
capsuleId = _currentIndex -1;
tokenIdOfColor[color] = capsuleId;
_colorOf[capsuleId] = color;
_fontOf[capsuleId] = font;
_textOf[capsuleId] = text;
emit MintCapsule(capsuleId, to, color, font, text);
}
function_setText(uint256 capsuleId, bytes32[8] calldata text)
internalonlyCapsuleOwner(capsuleId)
{
_textOf[capsuleId] = text;
emit SetCapsuleText(capsuleId, text);
}
function_setFont(uint256 capsuleId, Font calldata font)
internalonlyCapsuleOwner(capsuleId)
onlyValidFontForRenderer(font, rendererOf(capsuleId))
{
_fontOf[capsuleId] = font;
emit SetCapsuleFont(capsuleId, font);
}
function_addValidRenderer(address renderer) internal{
_validRenderers[renderer] =true;
emit AddValidRenderer(renderer);
}
/// @notice Check if all lines of text are empty./// @param text Text to check./// @return true if text is empty.function_isEmptyText(bytes32[8] memory text) internalpurereturns (bool) {
for (uint256 i; i <8; i++) {
if (!_isEmptyLine(text[i])) returnfalse;
}
returntrue;
}
/// @notice Returns the pure color matching a specific font weight./// @param fontWeight Font weight to return pure color for./// @return color Color for font weight.functionpureColorForFontWeight(uint256 fontWeight)
internalviewreturns (bytes3)
{
// 100 == pureColors[0]// 200 == pureColors[1]// 300 == pureColors[2]// etc...return pureColors[(fontWeight /100) -1];
}
/// @notice Check if line is empty./// @dev Returns true if every byte of text is 0x00./// @param line line to check./// @return true if line is empty.function_isEmptyLine(bytes32 line) internalpurereturns (bool) {
bytes2[16] memory _line = _bytes32ToBytes2Array(line);
for (uint256 i; i <16; i++) {
if (_line[i] !=0) returnfalse;
}
returntrue;
}
/// @notice Format bytes32 type as array of bytes2/// @param b bytes32 value to convert to array/// @return a Array of bytes2function_bytes32ToBytes2Array(bytes32 b)
internalpurereturns (bytes2[16] memory a)
{
for (uint256 i; i <16; i++) {
a[i] =bytes2(abi.encodePacked(b[i *2], b[i *2+1]));
}
}
function_setDefaultRenderer(address renderer) internal{
_addValidRenderer(renderer);
defaultRenderer = renderer;
emit SetDefaultRenderer(renderer);
}
function_setRoyalty(uint256 royaltyAmount) internal{
require(royaltyAmount <=1000, "Amount too high");
royalty = royaltyAmount;
emit SetRoyalty(royaltyAmount);
}
function_setContractURI(stringcalldata __contractURI) internal{
_contractURI = __contractURI;
emit SetContractURI(__contractURI);
}
function_setFeeReceiver(address newFeeReceiver) internal{
feeReceiver = newFeeReceiver;
emit SetFeeReceiver(newFeeReceiver);
}
function_setMetadata(address _capsuleMetadata) internal{
capsuleMetadata = _capsuleMetadata;
emit SetMetadata(_capsuleMetadata);
}
}
Contract Source Code
File 3 of 19: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^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 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 (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 4 of 19: ERC165.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol)pragmasolidity ^0.8.0;import"./IERC165.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*
* Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation.
*/abstractcontractERC165isIERC165{
/**
* @dev See {IERC165-supportsInterface}.
*/functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverridereturns (bool) {
return interfaceId ==type(IERC165).interfaceId;
}
}
Contract Source Code
File 5 of 19: ERC721A.sol
// SPDX-License-Identifier: MIT// Creator: Chiru Labspragmasolidity ^0.8.4;import'@openzeppelin/contracts/token/ERC721/IERC721.sol';
import'@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol';
import'@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol';
import'@openzeppelin/contracts/token/ERC721/extensions/IERC721Enumerable.sol';
import'@openzeppelin/contracts/utils/Address.sol';
import'@openzeppelin/contracts/utils/Context.sol';
import'@openzeppelin/contracts/utils/Strings.sol';
import'@openzeppelin/contracts/utils/introspection/ERC165.sol';
errorApprovalCallerNotOwnerNorApproved();
errorApprovalQueryForNonexistentToken();
errorApproveToCaller();
errorApprovalToCurrentOwner();
errorBalanceQueryForZeroAddress();
errorMintedQueryForZeroAddress();
errorBurnedQueryForZeroAddress();
errorAuxQueryForZeroAddress();
errorMintToZeroAddress();
errorMintZeroQuantity();
errorOwnerIndexOutOfBounds();
errorOwnerQueryForNonexistentToken();
errorTokenIndexOutOfBounds();
errorTransferCallerNotOwnerNorApproved();
errorTransferFromIncorrectOwner();
errorTransferToNonERC721ReceiverImplementer();
errorTransferToZeroAddress();
errorURIQueryForNonexistentToken();
/**
* @dev Implementation of https://eips.ethereum.org/EIPS/eip-721[ERC721] Non-Fungible Token Standard, including
* the Metadata extension. Built to optimize for lower gas during batch mints.
*
* Assumes serials are sequentially minted starting at _startTokenId() (defaults to 0, e.g. 0, 1, 2, 3..).
*
* Assumes that an owner cannot have more than 2**64 - 1 (max value of uint64) of supply.
*
* Assumes that the maximum token id cannot exceed 2**256 - 1 (max value of uint256).
*/contractERC721AisContext, ERC165, IERC721, IERC721Metadata{
usingAddressforaddress;
usingStringsforuint256;
// Compiler will pack this into a single 256bit word.structTokenOwnership {
// The address of the owner.address addr;
// Keeps track of the start time of ownership with minimal overhead for tokenomics.uint64 startTimestamp;
// Whether the token has been burned.bool burned;
}
// Compiler will pack this into a single 256bit word.structAddressData {
// Realistically, 2**64-1 is more than enough.uint64 balance;
// Keeps track of mint count with minimal overhead for tokenomics.uint64 numberMinted;
// Keeps track of burn count with minimal overhead for tokenomics.uint64 numberBurned;
// For miscellaneous variable(s) pertaining to the address// (e.g. number of whitelist mint slots used).// If there are multiple variables, please pack them into a uint64.uint64 aux;
}
// The tokenId of the next token to be minted.uint256internal _currentIndex;
// The number of tokens burned.uint256internal _burnCounter;
// Token namestringprivate _name;
// Token symbolstringprivate _symbol;
// Mapping from token ID to ownership details// An empty struct value does not necessarily mean the token is unowned. See ownershipOf implementation for details.mapping(uint256=> TokenOwnership) internal _ownerships;
// Mapping owner address to address datamapping(address=> AddressData) private _addressData;
// Mapping from token ID to approved addressmapping(uint256=>address) private _tokenApprovals;
// Mapping from owner to operator approvalsmapping(address=>mapping(address=>bool)) private _operatorApprovals;
constructor(stringmemory name_, stringmemory symbol_) {
_name = name_;
_symbol = symbol_;
_currentIndex = _startTokenId();
}
/**
* To change the starting tokenId, please override this function.
*/function_startTokenId() internalviewvirtualreturns (uint256) {
return0;
}
/**
* @dev See {IERC721Enumerable-totalSupply}.
* @dev Burned tokens are calculated here, use _totalMinted() if you want to count just minted tokens.
*/functiontotalSupply() publicviewreturns (uint256) {
// Counter underflow is impossible as _burnCounter cannot be incremented// more than _currentIndex - _startTokenId() timesunchecked {
return _currentIndex - _burnCounter - _startTokenId();
}
}
/**
* Returns the total amount of tokens minted in the contract.
*/function_totalMinted() internalviewreturns (uint256) {
// Counter underflow is impossible as _currentIndex does not decrement,// and it is initialized to _startTokenId()unchecked {
return _currentIndex - _startTokenId();
}
}
/**
* @dev See {IERC165-supportsInterface}.
*/functionsupportsInterface(bytes4 interfaceId) publicviewvirtualoverride(ERC165, IERC165) returns (bool) {
return
interfaceId ==type(IERC721).interfaceId||
interfaceId ==type(IERC721Metadata).interfaceId||super.supportsInterface(interfaceId);
}
/**
* @dev See {IERC721-balanceOf}.
*/functionbalanceOf(address owner) publicviewoverridereturns (uint256) {
if (owner ==address(0)) revert BalanceQueryForZeroAddress();
returnuint256(_addressData[owner].balance);
}
/**
* Returns the number of tokens minted by `owner`.
*/function_numberMinted(address owner) internalviewreturns (uint256) {
if (owner ==address(0)) revert MintedQueryForZeroAddress();
returnuint256(_addressData[owner].numberMinted);
}
/**
* Returns the number of tokens burned by or on behalf of `owner`.
*/function_numberBurned(address owner) internalviewreturns (uint256) {
if (owner ==address(0)) revert BurnedQueryForZeroAddress();
returnuint256(_addressData[owner].numberBurned);
}
/**
* Returns the auxillary data for `owner`. (e.g. number of whitelist mint slots used).
*/function_getAux(address owner) internalviewreturns (uint64) {
if (owner ==address(0)) revert AuxQueryForZeroAddress();
return _addressData[owner].aux;
}
/**
* Sets the auxillary data for `owner`. (e.g. number of whitelist mint slots used).
* If there are multiple variables, please pack them into a uint64.
*/function_setAux(address owner, uint64 aux) internal{
if (owner ==address(0)) revert AuxQueryForZeroAddress();
_addressData[owner].aux = aux;
}
/**
* Gas spent here starts off proportional to the maximum mint batch size.
* It gradually moves to O(1) as tokens get transferred around in the collection over time.
*/functionownershipOf(uint256 tokenId) internalviewreturns (TokenOwnership memory) {
uint256 curr = tokenId;
unchecked {
if (_startTokenId() <= curr && curr < _currentIndex) {
TokenOwnership memory ownership = _ownerships[curr];
if (!ownership.burned) {
if (ownership.addr !=address(0)) {
return ownership;
}
// Invariant:// There will always be an ownership that has an address and is not burned// before an ownership that does not have an address and is not burned.// Hence, curr will not underflow.while (true) {
curr--;
ownership = _ownerships[curr];
if (ownership.addr !=address(0)) {
return ownership;
}
}
}
}
}
revert OwnerQueryForNonexistentToken();
}
/**
* @dev See {IERC721-ownerOf}.
*/functionownerOf(uint256 tokenId) publicviewoverridereturns (address) {
return ownershipOf(tokenId).addr;
}
/**
* @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) {
if (!_exists(tokenId)) revert URIQueryForNonexistentToken();
stringmemory baseURI = _baseURI();
returnbytes(baseURI).length!=0 ? string(abi.encodePacked(baseURI, tokenId.toString())) : '';
}
/**
* @dev Base URI for computing {tokenURI}. If set, the resulting URI for each
* token will be the concatenation of the `baseURI` and the `tokenId`. Empty
* by default, can be overriden in child contracts.
*/function_baseURI() internalviewvirtualreturns (stringmemory) {
return'';
}
/**
* @dev See {IERC721-approve}.
*/functionapprove(address to, uint256 tokenId) publicoverride{
address owner = ERC721A.ownerOf(tokenId);
if (to == owner) revert ApprovalToCurrentOwner();
if (_msgSender() != owner &&!isApprovedForAll(owner, _msgSender())) {
revert ApprovalCallerNotOwnerNorApproved();
}
_approve(to, tokenId, owner);
}
/**
* @dev See {IERC721-getApproved}.
*/functiongetApproved(uint256 tokenId) publicviewoverridereturns (address) {
if (!_exists(tokenId)) revert ApprovalQueryForNonexistentToken();
return _tokenApprovals[tokenId];
}
/**
* @dev See {IERC721-setApprovalForAll}.
*/functionsetApprovalForAll(address operator, bool approved) publicoverride{
if (operator == _msgSender()) revert ApproveToCaller();
_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{
_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{
_transfer(from, to, tokenId);
if (to.isContract() &&!_checkContractOnERC721Received(from, to, tokenId, _data)) {
revert TransferToNonERC721ReceiverImplementer();
}
}
/**
* @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`),
*/function_exists(uint256 tokenId) internalviewreturns (bool) {
return _startTokenId() <= tokenId && tokenId < _currentIndex &&!_ownerships[tokenId].burned;
}
function_safeMint(address to, uint256 quantity) internal{
_safeMint(to, quantity, '');
}
/**
* @dev Safely mints `quantity` tokens and transfers them to `to`.
*
* Requirements:
*
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called for each safe transfer.
* - `quantity` must be greater than 0.
*
* Emits a {Transfer} event.
*/function_safeMint(address to,
uint256 quantity,
bytesmemory _data
) internal{
_mint(to, quantity, _data, true);
}
/**
* @dev Mints `quantity` tokens and transfers them to `to`.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - `quantity` must be greater than 0.
*
* Emits a {Transfer} event.
*/function_mint(address to,
uint256 quantity,
bytesmemory _data,
bool safe
) internal{
uint256 startTokenId = _currentIndex;
if (to ==address(0)) revert MintToZeroAddress();
if (quantity ==0) revert MintZeroQuantity();
_beforeTokenTransfers(address(0), to, startTokenId, quantity);
// Overflows are incredibly unrealistic.// balance or numberMinted overflow if current value of either + quantity > 1.8e19 (2**64) - 1// updatedIndex overflows if _currentIndex + quantity > 1.2e77 (2**256) - 1unchecked {
_addressData[to].balance+=uint64(quantity);
_addressData[to].numberMinted +=uint64(quantity);
_ownerships[startTokenId].addr = to;
_ownerships[startTokenId].startTimestamp =uint64(block.timestamp);
uint256 updatedIndex = startTokenId;
uint256 end = updatedIndex + quantity;
if (safe && to.isContract()) {
do {
emit Transfer(address(0), to, updatedIndex);
if (!_checkContractOnERC721Received(address(0), to, updatedIndex++, _data)) {
revert TransferToNonERC721ReceiverImplementer();
}
} while (updatedIndex != end);
// Reentrancy protectionif (_currentIndex != startTokenId) revert();
} else {
do {
emit Transfer(address(0), to, updatedIndex++);
} while (updatedIndex != end);
}
_currentIndex = updatedIndex;
}
_afterTokenTransfers(address(0), to, startTokenId, quantity);
}
/**
* @dev Transfers `tokenId` from `from` to `to`.
*
* 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
) private{
TokenOwnership memory prevOwnership = ownershipOf(tokenId);
bool isApprovedOrOwner = (_msgSender() == prevOwnership.addr ||
isApprovedForAll(prevOwnership.addr, _msgSender()) ||
getApproved(tokenId) == _msgSender());
if (!isApprovedOrOwner) revert TransferCallerNotOwnerNorApproved();
if (prevOwnership.addr !=from) revert TransferFromIncorrectOwner();
if (to ==address(0)) revert TransferToZeroAddress();
_beforeTokenTransfers(from, to, tokenId, 1);
// Clear approvals from the previous owner
_approve(address(0), tokenId, prevOwnership.addr);
// Underflow of the sender's balance is impossible because we check for// ownership above and the recipient's balance can't realistically overflow.// Counter overflow is incredibly unrealistic as tokenId would have to be 2**256.unchecked {
_addressData[from].balance-=1;
_addressData[to].balance+=1;
_ownerships[tokenId].addr = to;
_ownerships[tokenId].startTimestamp =uint64(block.timestamp);
// If the ownership slot of tokenId+1 is not explicitly set, that means the transfer initiator owns it.// Set the slot of tokenId+1 explicitly in storage to maintain correctness for ownerOf(tokenId+1) calls.uint256 nextTokenId = tokenId +1;
if (_ownerships[nextTokenId].addr ==address(0)) {
// This will suffice for checking _exists(nextTokenId),// as a burned slot cannot contain the zero address.if (nextTokenId < _currentIndex) {
_ownerships[nextTokenId].addr = prevOwnership.addr;
_ownerships[nextTokenId].startTimestamp = prevOwnership.startTimestamp;
}
}
}
emit Transfer(from, to, tokenId);
_afterTokenTransfers(from, to, tokenId, 1);
}
/**
* @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{
TokenOwnership memory prevOwnership = ownershipOf(tokenId);
_beforeTokenTransfers(prevOwnership.addr, address(0), tokenId, 1);
// Clear approvals from the previous owner
_approve(address(0), tokenId, prevOwnership.addr);
// Underflow of the sender's balance is impossible because we check for// ownership above and the recipient's balance can't realistically overflow.// Counter overflow is incredibly unrealistic as tokenId would have to be 2**256.unchecked {
_addressData[prevOwnership.addr].balance-=1;
_addressData[prevOwnership.addr].numberBurned +=1;
// Keep track of who burned the token, and the timestamp of burning.
_ownerships[tokenId].addr = prevOwnership.addr;
_ownerships[tokenId].startTimestamp =uint64(block.timestamp);
_ownerships[tokenId].burned =true;
// If the ownership slot of tokenId+1 is not explicitly set, that means the burn initiator owns it.// Set the slot of tokenId+1 explicitly in storage to maintain correctness for ownerOf(tokenId+1) calls.uint256 nextTokenId = tokenId +1;
if (_ownerships[nextTokenId].addr ==address(0)) {
// This will suffice for checking _exists(nextTokenId),// as a burned slot cannot contain the zero address.if (nextTokenId < _currentIndex) {
_ownerships[nextTokenId].addr = prevOwnership.addr;
_ownerships[nextTokenId].startTimestamp = prevOwnership.startTimestamp;
}
}
}
emit Transfer(prevOwnership.addr, address(0), tokenId);
_afterTokenTransfers(prevOwnership.addr, address(0), tokenId, 1);
// Overflow not possible, as _burnCounter cannot be exceed _currentIndex times.unchecked {
_burnCounter++;
}
}
/**
* @dev Approve `to` to operate on `tokenId`
*
* Emits a {Approval} event.
*/function_approve(address to,
uint256 tokenId,
address owner
) private{
_tokenApprovals[tokenId] = to;
emit Approval(owner, to, tokenId);
}
/**
* @dev Internal function to invoke {IERC721Receiver-onERC721Received} on a target 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_checkContractOnERC721Received(addressfrom,
address to,
uint256 tokenId,
bytesmemory _data
) privatereturns (bool) {
try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, _data) returns (bytes4 retval) {
return retval == IERC721Receiver(to).onERC721Received.selector;
} catch (bytesmemory reason) {
if (reason.length==0) {
revert TransferToNonERC721ReceiverImplementer();
} else {
assembly {
revert(add(32, reason), mload(reason))
}
}
}
}
/**
* @dev Hook that is called before a set of serially-ordered token ids are about to be transferred. This includes minting.
* And also called before burning one token.
*
* startTokenId - the first token id to be transferred
* quantity - the amount to be transferred
*
* 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, `tokenId` will be burned by `from`.
* - `from` and `to` are never both zero.
*/function_beforeTokenTransfers(addressfrom,
address to,
uint256 startTokenId,
uint256 quantity
) internalvirtual{}
/**
* @dev Hook that is called after a set of serially-ordered token ids have been transferred. This includes
* minting.
* And also called after one token has been burned.
*
* startTokenId - the first token id to be transferred
* quantity - the amount to be transferred
*
* Calling conditions:
*
* - When `from` and `to` are both non-zero, `from`'s `tokenId` has been
* transferred to `to`.
* - When `from` is zero, `tokenId` has been minted for `to`.
* - When `to` is zero, `tokenId` has been burned by `from`.
* - `from` and `to` are never both zero.
*/function_afterTokenTransfers(addressfrom,
address to,
uint256 startTokenId,
uint256 quantity
) internalvirtual{}
}
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.5.0) (interfaces/IERC2981.sol)pragmasolidity ^0.8.0;import"./IERC165.sol";
/**
* @dev Interface for the NFT Royalty Standard.
*
* A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
* support for royalty payments across all NFT marketplaces and ecosystem participants.
*
* _Available since v4.5._
*/interfaceIERC2981isIERC165{
/**
* @dev Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of
* exchange. The royalty amount is denominated and should be payed in that same unit of exchange.
*/functionroyaltyInfo(uint256 tokenId, uint256 salePrice)
externalviewreturns (address receiver, uint256 royaltyAmount);
}
Contract Source Code
File 11 of 19: IERC721.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721.sol)pragmasolidity ^0.8.0;import"../../utils/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 12 of 19: IERC721Enumerable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.5.0) (token/ERC721/extensions/IERC721Enumerable.sol)pragmasolidity ^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);
/**
* @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: MIT// OpenZeppelin Contracts v4.4.1 (token/ERC721/IERC721Receiver.sol)pragmasolidity ^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);
}
Contract Source Code
File 15 of 19: ITypeface.sol
// SPDX-License-Identifier: MIT/**
@title ITypeface
@author peri
@notice Interface for Typeface contract
*/pragmasolidity ^0.8.8;structFont {
uint256 weight;
string style;
}
interfaceITypeface{
/// @notice Emitted when the source is set for a font./// @param font The font the source has been set for.eventSetSource(Font font);
/// @notice Emitted when the source hash is set for a font./// @param font The font the source hash has been set for./// @param sourceHash The source hash that was set.eventSetSourceHash(Font font, bytes32 sourceHash);
/// @notice Emitted when the donation address is set./// @param donationAddress New donation address.eventSetDonationAddress(address donationAddress);
/// @notice Returns the typeface name.functionname() externalviewreturns (stringmemory);
/// @notice Check if typeface includes a glyph for a specific character code point./// @dev 3 bytes supports all possible unicodes./// @param codePoint Character code point./// @return true True if supported.functionsupportsCodePoint(bytes3 codePoint) externalviewreturns (bool);
/// @notice Return source data of Font./// @param font Font to return source data for./// @return source Source data of font.functionsourceOf(Font memory font) externalviewreturns (bytesmemory);
/// @notice Checks if source data has been stored for font./// @param font Font to check if source data exists for./// @return true True if source exists.functionhasSource(Font memory font) externalviewreturns (bool);
/// @notice Stores source data for a font./// @param font Font to store source data for./// @param source Source data of font.functionsetSource(Font memory font, bytesmemory source) external;
/// @notice Sets a new donation address./// @param donationAddress New donation address.functionsetDonationAddress(address donationAddress) external;
/// @notice Returns donation address/// @return donationAddress Donation address.functiondonationAddress() externalviewreturns (address);
}
Contract Source Code
File 16 of 19: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (access/Ownable.sol)pragmasolidity ^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() {
_transferOwnership(_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{
_transferOwnership(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");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Contract Source Code
File 17 of 19: Pausable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (security/Pausable.sol)pragmasolidity ^0.8.0;import"../utils/Context.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/abstractcontractPausableisContext{
/**
* @dev Emitted when the pause is triggered by `account`.
*/eventPaused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/eventUnpaused(address account);
boolprivate _paused;
/**
* @dev Initializes the contract in unpaused state.
*/constructor() {
_paused =false;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/functionpaused() publicviewvirtualreturns (bool) {
return _paused;
}
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/modifierwhenNotPaused() {
require(!paused(), "Pausable: paused");
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/modifierwhenPaused() {
require(paused(), "Pausable: not paused");
_;
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/function_pause() internalvirtualwhenNotPaused{
_paused =true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/function_unpause() internalvirtualwhenPaused{
_paused =false;
emit Unpaused(_msgSender());
}
}
Contract Source Code
File 18 of 19: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (security/ReentrancyGuard.sol)pragmasolidity ^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() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/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 19 of 19: Strings.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Strings.sol)pragmasolidity ^0.8.0;/**
* @dev String operations.
*/libraryStrings{
bytes16privateconstant _HEX_SYMBOLS ="0123456789abcdef";
/**
* @dev Converts a `uint256` to its ASCII `string` decimal 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);
while (value !=0) {
digits -=1;
buffer[digits] =bytes1(uint8(48+uint256(value %10)));
value /=10;
}
returnstring(buffer);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation.
*/functiontoHexString(uint256 value) internalpurereturns (stringmemory) {
if (value ==0) {
return"0x00";
}
uint256 temp = value;
uint256 length =0;
while (temp !=0) {
length++;
temp >>=8;
}
return toHexString(value, length);
}
/**
* @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length.
*/functiontoHexString(uint256 value, uint256 length) internalpurereturns (stringmemory) {
bytesmemory buffer =newbytes(2* length +2);
buffer[0] ="0";
buffer[1] ="x";
for (uint256 i =2* length +1; i >1; --i) {
buffer[i] = _HEX_SYMBOLS[value &0xf];
value >>=4;
}
require(value ==0, "Strings: hex length insufficient");
returnstring(buffer);
}
}