@artblocks/contracts 1.2.0 → 1.3.0

package/contracts/interfaces/v0.8.x/integration-refs/OpenSea/INonFungibleSeaDropToken.sol

@@ -0,0 +1,186 @@
+// SPDX-License-Identifier: MIT
+// @dev file is sourced from OpenSea's repository: https://github.com/ProjectOpenSea/seadrop/blob/main/src/interfaces/INonFungibleSeaDropToken.sol
+// @dev modified to not lock to specific version, as well as updated imports for this repository
+pragma solidity ^0.8.17;
+
+import {ISeaDropTokenContractMetadata} from "./ISeaDropTokenContractMetadata.sol";
+
+import {AllowListData, PublicDrop, TokenGatedDropStage, SignedMintValidationParams} from "./SeaDropStructs.sol";
+
+interface INonFungibleSeaDropToken is ISeaDropTokenContractMetadata {
+    /**
+     * @dev Revert with an error if a contract is not an allowed
+     *      SeaDrop address.
+     */
+    error OnlyAllowedSeaDrop();
+
+    /**
+     * @dev Emit an event when allowed SeaDrop contracts are updated.
+     */
+    event AllowedSeaDropUpdated(address[] allowedSeaDrop);
+
+    /**
+     * @notice Update the allowed SeaDrop contracts.
+     *         Only the owner can use this function.
+     *
+     * @param allowedSeaDrop The allowed SeaDrop addresses.
+     */
+    function updateAllowedSeaDrop(address[] calldata allowedSeaDrop) external;
+
+    /**
+     * @notice Mint tokens, restricted to the SeaDrop contract.
+     *
+     * @dev    NOTE: If a token registers itself with multiple SeaDrop
+     *         contracts, the implementation of this function should guard
+     *         against reentrancy. If the implementing token uses
+     *         _safeMint(), or a feeRecipient with a malicious receive() hook
+     *         is specified, the token or fee recipients may be able to execute
+     *         another mint in the same transaction via a separate SeaDrop
+     *         contract.
+     *         This is dangerous if an implementing token does not correctly
+     *         update the minterNumMinted and currentTotalSupply values before
+     *         transferring minted tokens, as SeaDrop references these values
+     *         to enforce token limits on a per-wallet and per-stage basis.
+     *
+     * @param minter   The address to mint to.
+     * @param quantity The number of tokens to mint.
+     */
+    function mintSeaDrop(address minter, uint256 quantity) external;
+
+    /**
+     * @notice Returns a set of mint stats for the address.
+     *         This assists SeaDrop in enforcing maxSupply,
+     *         maxTotalMintableByWallet, and maxTokenSupplyForStage checks.
+     *
+     * @dev    NOTE: Implementing contracts should always update these numbers
+     *         before transferring any tokens with _safeMint() to mitigate
+     *         consequences of malicious onERC721Received() hooks.
+     *
+     * @param minter The minter address.
+     */
+    function getMintStats(
+        address minter
+    )
+        external
+        view
+        returns (
+            uint256 minterNumMinted,
+            uint256 currentTotalSupply,
+            uint256 maxSupply
+        );
+
+    /**
+     * @notice Update the public drop data for this nft contract on SeaDrop.
+     *         Only the owner can use this function.
+     *
+     * @param seaDropImpl The allowed SeaDrop contract.
+     * @param publicDrop  The public drop data.
+     */
+    function updatePublicDrop(
+        address seaDropImpl,
+        PublicDrop calldata publicDrop
+    ) external;
+
+    /**
+     * @notice Update the allow list data for this nft contract on SeaDrop.
+     *         Only the owner can use this function.
+     *
+     * @param seaDropImpl   The allowed SeaDrop contract.
+     * @param allowListData The allow list data.
+     */
+    function updateAllowList(
+        address seaDropImpl,
+        AllowListData calldata allowListData
+    ) external;
+
+    /**
+     * @notice Update the token gated drop stage data for this nft contract
+     *         on SeaDrop.
+     *         Only the owner can use this function.
+     *
+     *         Note: If two INonFungibleSeaDropToken tokens are doing
+     *         simultaneous token gated drop promotions for each other,
+     *         they can be minted by the same actor until
+     *         `maxTokenSupplyForStage` is reached. Please ensure the
+     *         `allowedNftToken` is not running an active drop during the
+     *         `dropStage` time period.
+     *
+     *
+     * @param seaDropImpl     The allowed SeaDrop contract.
+     * @param allowedNftToken The allowed nft token.
+     * @param dropStage       The token gated drop stage data.
+     */
+    function updateTokenGatedDrop(
+        address seaDropImpl,
+        address allowedNftToken,
+        TokenGatedDropStage calldata dropStage
+    ) external;
+
+    /**
+     * @notice Update the drop URI for this nft contract on SeaDrop.
+     *         Only the owner can use this function.
+     *
+     * @param seaDropImpl The allowed SeaDrop contract.
+     * @param dropURI     The new drop URI.
+     */
+    function updateDropURI(
+        address seaDropImpl,
+        string calldata dropURI
+    ) external;
+
+    /**
+     * @notice Update the creator payout address for this nft contract on
+     *         SeaDrop.
+     *         Only the owner can set the creator payout address.
+     *
+     * @param seaDropImpl   The allowed SeaDrop contract.
+     * @param payoutAddress The new payout address.
+     */
+    function updateCreatorPayoutAddress(
+        address seaDropImpl,
+        address payoutAddress
+    ) external;
+
+    /**
+     * @notice Update the allowed fee recipient for this nft contract
+     *         on SeaDrop.
+     *
+     * @param seaDropImpl  The allowed SeaDrop contract.
+     * @param feeRecipient The new fee recipient.
+     */
+    function updateAllowedFeeRecipient(
+        address seaDropImpl,
+        address feeRecipient,
+        bool allowed
+    ) external;
+
+    /**
+     * @notice Update the server-side signers for this nft contract
+     *         on SeaDrop.
+     *         Only the owner can use this function.
+     *
+     * @param seaDropImpl                The allowed SeaDrop contract.
+     * @param signer                     The signer to update.
+     * @param signedMintValidationParams Minimum and maximum parameters
+     *                                   to enforce for signed mints.
+     */
+    function updateSignedMintValidationParams(
+        address seaDropImpl,
+        address signer,
+        SignedMintValidationParams memory signedMintValidationParams
+    ) external;
+
+    /**
+     * @notice Update the allowed payers for this nft contract on SeaDrop.
+     *         Only the owner can use this function.
+     *
+     * @param seaDropImpl The allowed SeaDrop contract.
+     * @param payer       The payer to update.
+     * @param allowed     Whether the payer is allowed.
+     */
+    function updatePayer(
+        address seaDropImpl,
+        address payer,
+        bool allowed
+    ) external;
+}

package/contracts/interfaces/v0.8.x/integration-refs/OpenSea/ISeaDrop.sol

@@ -0,0 +1,337 @@
+// SPDX-License-Identifier: MIT
+// @dev file is sourced from OpenSea's repository: https://github.com/ProjectOpenSea/seadrop/blob/main/src/interfaces/ISeaDrop.sol
+// @dev modified to not lock to specific version, as well as updated imports for this repository
+pragma solidity ^0.8.17;
+
+import {AllowListData, MintParams, PublicDrop, TokenGatedDropStage, TokenGatedMintParams, SignedMintValidationParams} from "./SeaDropStructs.sol";
+
+import {SeaDropErrorsAndEvents} from "./SeaDropErrorsAndEvents.sol";
+
+interface ISeaDrop is SeaDropErrorsAndEvents {
+    /**
+     * @notice Mint a public drop.
+     *
+     * @param nftContract      The nft contract to mint.
+     * @param feeRecipient     The fee recipient.
+     * @param minterIfNotPayer The mint recipient if different than the payer.
+     * @param quantity         The number of tokens to mint.
+     */
+    function mintPublic(
+        address nftContract,
+        address feeRecipient,
+        address minterIfNotPayer,
+        uint256 quantity
+    ) external payable;
+
+    /**
+     * @notice Mint from an allow list.
+     *
+     * @param nftContract      The nft contract to mint.
+     * @param feeRecipient     The fee recipient.
+     * @param minterIfNotPayer The mint recipient if different than the payer.
+     * @param quantity         The number of tokens to mint.
+     * @param mintParams       The mint parameters.
+     * @param proof            The proof for the leaf of the allow list.
+     */
+    function mintAllowList(
+        address nftContract,
+        address feeRecipient,
+        address minterIfNotPayer,
+        uint256 quantity,
+        MintParams calldata mintParams,
+        bytes32[] calldata proof
+    ) external payable;
+
+    /**
+     * @notice Mint with a server-side signature.
+     *         Note that a signature can only be used once.
+     *
+     * @param nftContract      The nft contract to mint.
+     * @param feeRecipient     The fee recipient.
+     * @param minterIfNotPayer The mint recipient if different than the payer.
+     * @param quantity         The number of tokens to mint.
+     * @param mintParams       The mint parameters.
+     * @param salt             The sale for the signed mint.
+     * @param signature        The server-side signature, must be an allowed
+     *                         signer.
+     */
+    function mintSigned(
+        address nftContract,
+        address feeRecipient,
+        address minterIfNotPayer,
+        uint256 quantity,
+        MintParams calldata mintParams,
+        uint256 salt,
+        bytes calldata signature
+    ) external payable;
+
+    /**
+     * @notice Mint as an allowed token holder.
+     *         This will mark the token id as redeemed and will revert if the
+     *         same token id is attempted to be redeemed twice.
+     *
+     * @param nftContract      The nft contract to mint.
+     * @param feeRecipient     The fee recipient.
+     * @param minterIfNotPayer The mint recipient if different than the payer.
+     * @param mintParams       The token gated mint params.
+     */
+    function mintAllowedTokenHolder(
+        address nftContract,
+        address feeRecipient,
+        address minterIfNotPayer,
+        TokenGatedMintParams calldata mintParams
+    ) external payable;
+
+    /**
+     * @notice Emits an event to notify update of the drop URI.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     * @param dropURI The new drop URI.
+     */
+    function updateDropURI(string calldata dropURI) external;
+
+    /**
+     * @notice Updates the public drop data for the nft contract
+     *         and emits an event.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     * @param publicDrop The public drop data.
+     */
+    function updatePublicDrop(PublicDrop calldata publicDrop) external;
+
+    /**
+     * @notice Updates the allow list merkle root for the nft contract
+     *         and emits an event.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     * @param allowListData The allow list data.
+     */
+    function updateAllowList(AllowListData calldata allowListData) external;
+
+    /**
+     * @notice Updates the token gated drop stage for the nft contract
+     *         and emits an event.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     *         Note: If two INonFungibleSeaDropToken tokens are doing
+     *         simultaneous token gated drop promotions for each other,
+     *         they can be minted by the same actor until
+     *         `maxTokenSupplyForStage` is reached. Please ensure the
+     *         `allowedNftToken` is not running an active drop during
+     *         the `dropStage` time period.
+     *
+     * @param allowedNftToken The token gated nft token.
+     * @param dropStage       The token gated drop stage data.
+     */
+    function updateTokenGatedDrop(
+        address allowedNftToken,
+        TokenGatedDropStage calldata dropStage
+    ) external;
+
+    /**
+     * @notice Updates the creator payout address and emits an event.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     * @param payoutAddress The creator payout address.
+     */
+    function updateCreatorPayoutAddress(address payoutAddress) external;
+
+    /**
+     * @notice Updates the allowed fee recipient and emits an event.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     * @param feeRecipient The fee recipient.
+     * @param allowed      If the fee recipient is allowed.
+     */
+    function updateAllowedFeeRecipient(
+        address feeRecipient,
+        bool allowed
+    ) external;
+
+    /**
+     * @notice Updates the allowed server-side signers and emits an event.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     * @param signer                     The signer to update.
+     * @param signedMintValidationParams Minimum and maximum parameters
+     *                                   to enforce for signed mints.
+     */
+    function updateSignedMintValidationParams(
+        address signer,
+        SignedMintValidationParams calldata signedMintValidationParams
+    ) external;
+
+    /**
+     * @notice Updates the allowed payer and emits an event.
+     *
+     *         This method assume msg.sender is an nft contract and its
+     *         ERC165 interface id matches INonFungibleSeaDropToken.
+     *
+     *         Note: Be sure only authorized users can call this from
+     *         token contracts that implement INonFungibleSeaDropToken.
+     *
+     * @param payer   The payer to add or remove.
+     * @param allowed Whether to add or remove the payer.
+     */
+    function updatePayer(address payer, bool allowed) external;
+
+    /**
+     * @notice Returns the public drop data for the nft contract.
+     *
+     * @param nftContract The nft contract.
+     */
+    function getPublicDrop(
+        address nftContract
+    ) external view returns (PublicDrop memory);
+
+    /**
+     * @notice Returns the creator payout address for the nft contract.
+     *
+     * @param nftContract The nft contract.
+     */
+    function getCreatorPayoutAddress(
+        address nftContract
+    ) external view returns (address);
+
+    /**
+     * @notice Returns the allow list merkle root for the nft contract.
+     *
+     * @param nftContract The nft contract.
+     */
+    function getAllowListMerkleRoot(
+        address nftContract
+    ) external view returns (bytes32);
+
+    /**
+     * @notice Returns if the specified fee recipient is allowed
+     *         for the nft contract.
+     *
+     * @param nftContract  The nft contract.
+     * @param feeRecipient The fee recipient.
+     */
+    function getFeeRecipientIsAllowed(
+        address nftContract,
+        address feeRecipient
+    ) external view returns (bool);
+
+    /**
+     * @notice Returns an enumeration of allowed fee recipients for an
+     *         nft contract when fee recipients are enforced
+     *
+     * @param nftContract The nft contract.
+     */
+    function getAllowedFeeRecipients(
+        address nftContract
+    ) external view returns (address[] memory);
+
+    /**
+     * @notice Returns the server-side signers for the nft contract.
+     *
+     * @param nftContract The nft contract.
+     */
+    function getSigners(
+        address nftContract
+    ) external view returns (address[] memory);
+
+    /**
+     * @notice Returns the struct of SignedMintValidationParams for a signer.
+     *
+     * @param nftContract The nft contract.
+     * @param signer      The signer.
+     */
+    function getSignedMintValidationParams(
+        address nftContract,
+        address signer
+    ) external view returns (SignedMintValidationParams memory);
+
+    /**
+     * @notice Returns the payers for the nft contract.
+     *
+     * @param nftContract The nft contract.
+     */
+    function getPayers(
+        address nftContract
+    ) external view returns (address[] memory);
+
+    /**
+     * @notice Returns if the specified payer is allowed
+     *         for the nft contract.
+     *
+     * @param nftContract The nft contract.
+     * @param payer       The payer.
+     */
+    function getPayerIsAllowed(
+        address nftContract,
+        address payer
+    ) external view returns (bool);
+
+    /**
+     * @notice Returns the allowed token gated drop tokens for the nft contract.
+     *
+     * @param nftContract The nft contract.
+     */
+    function getTokenGatedAllowedTokens(
+        address nftContract
+    ) external view returns (address[] memory);
+
+    /**
+     * @notice Returns the token gated drop data for the nft contract
+     *         and token gated nft.
+     *
+     * @param nftContract     The nft contract.
+     * @param allowedNftToken The token gated nft token.
+     */
+    function getTokenGatedDrop(
+        address nftContract,
+        address allowedNftToken
+    ) external view returns (TokenGatedDropStage memory);
+
+    /**
+     * @notice Returns whether the token id for a token gated drop has been
+     *         redeemed.
+     *
+     * @param nftContract       The nft contract.
+     * @param allowedNftToken   The token gated nft token.
+     * @param allowedNftTokenId The token gated nft token id to check.
+     */
+    function getAllowedNftTokenIdIsRedeemed(
+        address nftContract,
+        address allowedNftToken,
+        uint256 allowedNftTokenId
+    ) external view returns (bool);
+}

package/contracts/interfaces/v0.8.x/integration-refs/OpenSea/ISeaDropTokenContractMetadata.sol

@@ -0,0 +1,152 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.17;
+// @dev file is sourced from OpenSea's repository: https://github.com/ProjectOpenSea/seadrop/blob/main/src/interfaces/ISeaDropTokenContractMetadata.sol
+// @dev modified to not lock to specific version, as well as updated imports for this repository
+
+// @dev OpenSea's repo referenced v4.7 of OpenZeppelin, so importing from that version here
+import {IERC2981} from "@openzeppelin-4.7/contracts/interfaces/IERC2981.sol";
+
+interface ISeaDropTokenContractMetadata is IERC2981 {
+    /**
+     * @notice Throw if the max supply exceeds uint64, a limit
+     *         due to the storage of bit-packed variables in ERC721A.
+     */
+    error CannotExceedMaxSupplyOfUint64(uint256 newMaxSupply);
+
+    /**
+     * @notice Throw if the max supply exceeds the total minted.
+     */
+    error NewMaxSupplyCannotBeLessThenTotalMinted(
+        uint256 got,
+        uint256 totalMinted
+    );
+
+    /**
+     * @dev Revert with an error when attempting to set the provenance
+     *      hash after the mint has started.
+     */
+    error ProvenanceHashCannotBeSetAfterMintStarted();
+
+    /**
+     * @dev Revert if the royalty basis points is greater than 10_000.
+     */
+    error InvalidRoyaltyBasisPoints(uint256 basisPoints);
+
+    /**
+     * @dev Revert if the royalty address is being set to the zero address.
+     */
+    error RoyaltyAddressCannotBeZeroAddress();
+
+    /**
+     * @dev Emit an event for token metadata reveals/updates,
+     *      according to EIP-4906.
+     *
+     * @param _fromTokenId The start token id.
+     * @param _toTokenId   The end token id.
+     */
+    event BatchMetadataUpdate(uint256 _fromTokenId, uint256 _toTokenId);
+
+    /**
+     * @dev Emit an event when the URI for the collection-level metadata
+     *      is updated.
+     */
+    event ContractURIUpdated(string newContractURI);
+
+    /**
+     * @dev Emit an event when the max token supply is updated.
+     */
+    event MaxSupplyUpdated(uint256 newMaxSupply);
+
+    /**
+     * @dev Emit an event with the previous and new provenance hash after
+     *      being updated.
+     */
+    event ProvenanceHashUpdated(bytes32 previousHash, bytes32 newHash);
+
+    /**
+     * @dev Emit an event when the royalties info is updated.
+     */
+    event RoyaltyInfoUpdated(address receiver, uint256 bps);
+
+    /**
+     * @notice A struct defining royalty info for the contract.
+     */
+    struct RoyaltyInfo {
+        address royaltyAddress;
+        uint96 royaltyBps;
+    }
+
+    /**
+     * @notice Sets the base URI for the token metadata and emits an event.
+     *
+     * @param tokenURI The new base URI to set.
+     */
+    function setBaseURI(string calldata tokenURI) external;
+
+    /**
+     * @notice Sets the contract URI for contract metadata.
+     *
+     * @param newContractURI The new contract URI.
+     */
+    function setContractURI(string calldata newContractURI) external;
+
+    /**
+     * @notice Sets the max supply and emits an event.
+     *
+     * @param newMaxSupply The new max supply to set.
+     */
+    function setMaxSupply(uint256 newMaxSupply) external;
+
+    /**
+     * @notice Sets the provenance hash and emits an event.
+     *
+     *         The provenance hash is used for random reveals, which
+     *         is a hash of the ordered metadata to show it has not been
+     *         modified after mint started.
+     *
+     *         This function will revert after the first item has been minted.
+     *
+     * @param newProvenanceHash The new provenance hash to set.
+     */
+    function setProvenanceHash(bytes32 newProvenanceHash) external;
+
+    /**
+     * @notice Sets the address and basis points for royalties.
+     *
+     * @param newInfo The struct to configure royalties.
+     */
+    function setRoyaltyInfo(RoyaltyInfo calldata newInfo) external;
+
+    /**
+     * @notice Returns the base URI for token metadata.
+     */
+    function baseURI() external view returns (string memory);
+
+    /**
+     * @notice Returns the contract URI.
+     */
+    function contractURI() external view returns (string memory);
+
+    /**
+     * @notice Returns the max token supply.
+     */
+    function maxSupply() external view returns (uint256);
+
+    /**
+     * @notice Returns the provenance hash.
+     *         The provenance hash is used for random reveals, which
+     *         is a hash of the ordered metadata to show it is unmodified
+     *         after mint has started.
+     */
+    function provenanceHash() external view returns (bytes32);
+
+    /**
+     * @notice Returns the address that receives royalties.
+     */
+    function royaltyAddress() external view returns (address);
+
+    /**
+     * @notice Returns the royalty basis points out of 10_000.
+     */
+    function royaltyBasisPoints() external view returns (uint256);
+}