Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (proxy/Proxy.sol)
pragma solidity ^0.8.0;
/**
* @dev This abstract contract provides a fallback function that delegates all calls to another contract using the EVM
* instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to
* be specified by overriding the virtual {_implementation} function.
*
* Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a
* different contract through the {_delegate} function.
*
* The success and return data of the delegated call will be returned back to the caller of the proxy.
*/
abstract contract Proxy {
/**
* @dev Delegates the current call to `implementation`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _delegate(address implementation) internal virtual {
assembly {
// Copy msg.data. We take full control of memory in this inline assembly
// block because it will not return to Solidity code. We overwrite the
// Solidity scratch pad at memory position 0.
calldatacopy(0, 0, calldatasize())
// Call the implementation.
// out and outsize are 0 because we don't know the size yet.
let result := delegatecall(gas(), implementation, 0, calldatasize(), 0, 0)
// Copy the returned data.
returndatacopy(0, 0, returndatasize())
switch result
// delegatecall returns 0 on error.
case 0 {
revert(0, returndatasize())
}
default {
return(0, returndatasize())
}
}
}
/**
* @dev This is a virtual function that should be overridden so it returns the address to which the fallback function
* and {_fallback} should delegate.
*/
function _implementation() internal view virtual returns (address);
/**
* @dev Delegates the current call to the address returned by `_implementation()`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _fallback() internal virtual {
_beforeFallback();
_delegate(_implementation());
}
/**
* @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if no other
* function in the contract matches the call data.
*/
fallback() external payable virtual {
_fallback();
}
/**
* @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if call data
* is empty.
*/
receive() external payable virtual {
_fallback();
}
/**
* @dev Hook that is called before falling back to the implementation. Can happen as part of a manual `_fallback`
* call, or as part of the Solidity `fallback` or `receive` functions.
*
* If overridden should call `super._beforeFallback()`.
*/
function _beforeFallback() internal virtual {}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/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.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.0;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC1967 implementation slot:
* ```solidity
* contract ERC1967 {
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract");
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* _Available since v4.1 for `address`, `bool`, `bytes32`, `uint256`._
* _Available since v4.9 for `string`, `bytes`._
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
/**
* @dev Returns an `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.10;
import "../../mint/interfaces/IAbridgedMintVector.sol";
import "../../mint/mechanics/interfaces/IMechanicMintManager.sol";
import "@openzeppelin/contracts/proxy/Proxy.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@openzeppelin/contracts/utils/StorageSlot.sol";
/**
* @notice Instance of Series contract (unique metadata per token in collection)
* @author highlight.xyz
*/
contract Series is Proxy {
/**
* @notice Set up Series instance
* @param implementation_ General721 implementation
* @param initializeData Data to initialize Series contract
* @ param creator Creator/owner of contract
* @ param _contractURI Contract metadata
* @ param defaultRoyalty Default royalty object for contract (optional)
* @ param _defaultTokenManager Default token manager for contract (optional)
* @ param _name Name of token edition
* @ param _symbol Symbol of the token edition
* @ param trustedForwarder Trusted minimal forwarder
* @ param initialMinter Initial minter to register
* @ param newBaseURI Base URI for contract
* @ param _limitSupply Initial limit supply
* @ param useMarketplaceFiltererRegistry Denotes whether to use marketplace filterer registry
* @ param _observability Observability contract address
* @param mintVectorData Mint vector data
* @ param mintManager
* @ param paymentRecipient
* @ param startTimestamp
* @ param endTimestamp
* @ param pricePerToken
* @ param tokenLimitPerTx
* @ param maxTotalClaimableViaVector
* @ param maxUserClaimableViaVector
* @ param allowlistRoot
* @param mechanicVectorData Mechanic mint vector data
* @ param mechanicVectorId Global mechanic vector ID
* @ param mechanic Mechanic address
* @ param mintManager Mint manager address
* @ param vectorData Vector data
* @param isCollectorsChoice True if series will have collector's choice based minting
*/
constructor(
address implementation_,
bytes memory initializeData,
bytes memory mintVectorData,
bytes memory mechanicVectorData,
bool isCollectorsChoice
) {
assert(_IMPLEMENTATION_SLOT == bytes32(uint256(keccak256("eip1967.proxy.implementation")) - 1));
StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = implementation_;
Address.functionDelegateCall(implementation_, abi.encodeWithSignature("initialize(bytes)", initializeData));
if (mintVectorData.length > 0) {
(
address mintManager,
address paymentRecipient,
uint48 startTimestamp,
uint48 endTimestamp,
uint192 pricePerToken,
uint48 tokenLimitPerTx,
uint48 maxTotalClaimableViaVector,
uint48 maxUserClaimableViaVector,
bytes32 allowlistRoot
) = abi.decode(
mintVectorData,
(address, address, uint48, uint48, uint192, uint48, uint48, uint48, bytes32)
);
IAbridgedMintVector(mintManager).createAbridgedVector(
IAbridgedMintVector.AbridgedVectorData(
uint160(address(this)),
startTimestamp,
endTimestamp,
uint160(paymentRecipient),
maxTotalClaimableViaVector,
0,
0,
tokenLimitPerTx,
maxUserClaimableViaVector,
pricePerToken,
0,
false,
false,
allowlistRoot
)
);
}
if (mechanicVectorData.length != 0) {
(uint96 seed, address mechanic, address mintManager, bytes memory vectorData) = abi.decode(
mechanicVectorData,
(uint96, address, address, bytes)
);
IMechanicMintManager(mintManager).registerMechanicVector(
IMechanicData.MechanicVectorMetadata(address(this), 0, mechanic, false, isCollectorsChoice, false),
seed,
vectorData
);
}
}
/**
* @notice Return the contract type
*/
function standard() external pure returns (string memory) {
return "Series2";
}
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev Returns the current implementation address.
*/
function implementation() public view returns (address) {
return _implementation();
}
function _implementation() internal view override returns (address) {
return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.10;
/**
* @title MintManager interface for onchain abridged mint vectors
* @author highlight.xyz
*/
interface IAbridgedMintVector {
/**
* @notice On-chain mint vector (stored data)
* @param contractAddress NFT smart contract address
* @param startTimestamp When minting opens on vector
* @param endTimestamp When minting ends on vector
* @param paymentRecipient Payment recipient
* @param maxTotalClaimableViaVector Max number of tokens that can be minted via vector
* @param totalClaimedViaVector Total number of tokens minted via vector
* @param currency Currency used for payment. Native gas token, if zero address
* @param tokenLimitPerTx Max number of tokens that can be minted in one transaction
* @param maxUserClaimableViaVector Max number of tokens that can be minted by user via vector
* @param pricePerToken Price that has to be paid per minted token
* @param editionId Edition ID, if vector is for edition based collection
* @param editionBasedCollection If vector is for an edition based collection
* @param requireDirectEOA Require minters to directly be EOAs
* @param allowlistRoot Root of merkle tree with allowlist
*/
struct AbridgedVectorData {
uint160 contractAddress;
uint48 startTimestamp;
uint48 endTimestamp;
uint160 paymentRecipient;
uint48 maxTotalClaimableViaVector;
uint48 totalClaimedViaVector;
uint160 currency;
uint48 tokenLimitPerTx;
uint48 maxUserClaimableViaVector;
uint192 pricePerToken;
uint48 editionId;
bool editionBasedCollection;
bool requireDirectEOA;
bytes32 allowlistRoot;
}
/**
* @notice On-chain mint vector (public) - See {AbridgedVectorData}
*/
struct AbridgedVector {
address contractAddress;
uint48 startTimestamp;
uint48 endTimestamp;
address paymentRecipient;
uint48 maxTotalClaimableViaVector;
uint48 totalClaimedViaVector;
address currency;
uint48 tokenLimitPerTx;
uint48 maxUserClaimableViaVector;
uint192 pricePerToken;
uint48 editionId;
bool editionBasedCollection;
bool requireDirectEOA;
bytes32 allowlistRoot;
}
/**
* @notice Config defining what fields to update
* @param updateStartTimestamp If 1, update startTimestamp
* @param updateEndTimestamp If 1, update endTimestamp
* @param updatePaymentRecipient If 1, update paymentRecipient
* @param updateMaxTotalClaimableViaVector If 1, update maxTotalClaimableViaVector
* @param updateTokenLimitPerTx If 1, update tokenLimitPerTx
* @param updateMaxUserClaimableViaVector If 1, update maxUserClaimableViaVector
* @param updatePricePerToken If 1, update pricePerToken
* @param updateAllowlistRoot If 1, update allowlistRoot
* @param updateRequireDirectEOA If 1, update requireDirectEOA
* @param updateMetadata If 1, update MintVector metadata
*/
struct UpdateAbridgedVectorConfig {
uint16 updateStartTimestamp;
uint16 updateEndTimestamp;
uint16 updatePaymentRecipient;
uint16 updateMaxTotalClaimableViaVector;
uint16 updateTokenLimitPerTx;
uint16 updateMaxUserClaimableViaVector;
uint8 updatePricePerToken;
uint8 updateAllowlistRoot;
uint8 updateRequireDirectEOA;
uint8 updateMetadata;
}
/**
* @notice Creates on-chain vector
* @param _vector Vector to create
*/
function createAbridgedVector(AbridgedVectorData memory _vector) external;
/**
* @notice Updates on-chain vector
* @param vectorId ID of vector to update
* @param _newVector New vector details
* @param updateConfig Number encoding what fields to update
* @param pause Pause / unpause vector
* @param flexibleData Flexible data in vector metadata
*/
function updateAbridgedVector(
uint256 vectorId,
AbridgedVector calldata _newVector,
UpdateAbridgedVectorConfig calldata updateConfig,
bool pause,
uint128 flexibleData
) external;
/**
* @notice Deletes on-chain vector
* @param vectorId ID of abridged vector to delete
*/
function deleteAbridgedVector(uint256 vectorId) external;
/**
* @notice Pauses or unpauses an on-chain mint vector
* @param vectorId ID of abridged vector to pause
* @param pause True to pause, False to unpause
* @param flexibleData Flexible data that can be interpreted differently
*/
function setAbridgedVectorMetadata(uint256 vectorId, bool pause, uint128 flexibleData) external;
/**
* @notice Get on-chain abridged vector
* @param vectorId ID of abridged vector to get
*/
function getAbridgedVector(uint256 vectorId) external view returns (AbridgedVector memory);
/**
* @notice Get on-chain abridged vector metadata
* @param vectorId ID of abridged vector to get
*/
function getAbridgedVectorMetadata(uint256 vectorId) external view returns (bool, uint128);
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.10;
/**
* @notice Defines a mechanic's metadata on the MintManager
*/
interface IMechanicData {
/**
* @notice A mechanic's metadata
* @param contractAddress Collection contract address
* @param editionId Edition ID if the collection is edition based
* @param mechanic Address of mint mechanic contract
* @param isEditionBased True if collection is edition based
* @param isChoose True if collection uses a collector's choice mint paradigm
* @param paused True if mechanic vector is paused
*/
struct MechanicVectorMetadata {
address contractAddress;
uint96 editionId;
address mechanic;
bool isEditionBased;
bool isChoose;
bool paused;
}
}
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.10;
import "./IMechanicData.sol";
/**
* @notice Capabilities on MintManager pertaining to mechanics
*/
interface IMechanicMintManager is IMechanicData {
/**
* @notice Register a new mechanic vector
* @param _mechanicVectorMetadata Mechanic vector metadata
* @param seed Used to seed uniqueness into mechanic vector ID generation
* @param vectorData Vector data to store on mechanic (optional)
*/
function registerMechanicVector(
MechanicVectorMetadata calldata _mechanicVectorMetadata,
uint96 seed,
bytes calldata vectorData
) external;
/**
* @notice Pause or unpause a mechanic vector
* @param mechanicVectorId Global mechanic ID
* @param pause If true, pause the mechanic mint vector. If false, unpause
*/
function setPauseOnMechanicMintVector(bytes32 mechanicVectorId, bool pause) external;
/**
* @notice Mint a number of tokens sequentially via a mechanic vector
* @param mechanicVectorId Global mechanic ID
* @param recipient Mint recipient
* @param numToMint Number of tokens to mint
* @param data Custom data to be processed by mechanic
*/
function mechanicMintNum(
bytes32 mechanicVectorId,
address recipient,
uint32 numToMint,
bytes calldata data
) external payable;
/**
* @notice Mint a specific set of token ids via a mechanic vector
* @param mechanicVectorId Global mechanic ID
* @param recipient Mint recipient
* @param tokenIds IDs of tokens to mint
* @param data Custom data to be processed by mechanic
*/
function mechanicMintChoose(
bytes32 mechanicVectorId,
address recipient,
uint256[] calldata tokenIds,
bytes calldata data
) external payable;
}