@artblocks/contracts 1.2.0 → 1.3.0

package/contracts/interfaces/v0.8.x/IGenArt721CoreProjectScriptV1.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity ^0.8.0;
+
+/**
+ * @dev This interface is implemented by GenArt721CoreV3 and above
+ */
+interface IGenArt721CoreProjectScriptV1 {
+    function projectScriptDetails(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            string memory scriptTypeAndVersion,
+            string memory aspectRatio,
+            uint256 scriptCount
+        );
+
+    function projectScriptBytecodeAddressByIndex(
+        uint256 _projectId,
+        uint256 _index
+    ) external view returns (address);
+}

package/contracts/interfaces/v0.8.x/IGenArt721CoreTokenHashProviderV0.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity ^0.8.0;
+
+/**
+ * @dev This interface is implemented by the GenArt721 (GenArt721CoreV0)
+ */
+interface IGenArt721CoreTokenHashProviderV0 {
+    function showTokenHashes(
+        uint256 _tokenId
+    ) external view returns (bytes32[] memory);
+}

package/contracts/interfaces/v0.8.x/IGenArt721CoreTokenHashProviderV1.sol

@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity ^0.8.0;
+
+/**
+ * @dev This interface is implemented by GenArt721CoreV1 and above.
+ */
+interface IGenArt721CoreTokenHashProviderV1 {
+    function tokenIdToHash(uint256 tokenId) external view returns (bytes32);
+}

package/contracts/interfaces/v0.8.x/IGenArt721GeneratorV0.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+pragma solidity ^0.8.22;
+
+interface IGenArt721GeneratorV0 {
+    event DependencyRegistryUpdated(address indexed _dependencyRegistry);
+    event ScriptyBuilderUpdated(address indexed _scriptyBuilder);
+    event GunzipScriptBytecodeAddressUpdated(
+        address indexed _gunzipScriptBytecodeAddress
+    );
+    event UniversalBytecodeStorageReaderUpdated(
+        address indexed _universalBytecodeStorageReader
+    );
+}

package/contracts/interfaces/v0.8.x/IOwnedCreate2FactoryV0.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {EngineConfiguration} from "./IGenArt721CoreContractV3_Engine.sol";
+
+interface IOwnedCreate2FactoryV0 {
+    /**
+     * @notice This contract was deployed.
+     */
+    event Deployed();
+    /**
+     * @notice New curated core contract was created.
+     * @param newContract new contract
+     */
+    event ContractCreated(address indexed newContract);
+
+    /**
+     * @notice Drains the contract's balance to the `recipient`.
+     * @param recipient The address to send funds to.
+     * Only callable by the owner.
+     */
+    function drainETH(address payable recipient) external;
+
+    /**
+     * @notice Drains the contract's balance of an input ERC20 token to
+     * the `recipient`.
+     * @param ERC20TokenAddress The address of the ERC20 token to withdraw.
+     * @param recipient The address to send ERC20 tokens to.
+     * Only callable by the owner.
+     */
+    function drainERC20(address ERC20TokenAddress, address recipient) external;
+
+    /**
+     * @notice Indicates the type of the contract, e.g. `EngineFactoryV0`.
+     * @return type_ The type of the contract.
+     */
+    function type_() external pure returns (bytes32);
+}

package/contracts/interfaces/v0.8.x/IPMPAugmentHook.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IPMPV0} from "./IPMPV0.sol";
+import {IWeb3Call} from "./IWeb3Call.sol";
+
+import {IERC165} from "@openzeppelin-5.0/contracts/interfaces/IERC165.sol";
+
+interface IPMPAugmentHook is IERC165 {
+    /**
+     * @notice Augment the token parameters for a given token.
+     * @dev This hook is called when a token's PMPs are read.
+     * @dev This must return all desired tokenParams, not just additional data.
+     * @param coreContract The address of the core contract to call.
+     * @param tokenId The tokenId of the token to get data for.
+     * @param tokenParams The token parameters for the queried token.
+     * @return augmentedTokenParams The augmented token parameters.
+     */
+    function onTokenPMPReadAugmentation(
+        address coreContract,
+        uint256 tokenId,
+        IWeb3Call.TokenParam[] calldata tokenParams
+    )
+        external
+        view
+        returns (IWeb3Call.TokenParam[] memory augmentedTokenParams);
+
+    // @dev ERC156 function supportsInterface must be implemented and broadcast true for this interfaceId
+}

package/contracts/interfaces/v0.8.x/IPMPConfigureHook.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IPMPV0} from "./IPMPV0.sol";
+
+import {IERC165} from "@openzeppelin-5.0/contracts/interfaces/IERC165.sol";
+
+interface IPMPConfigureHook is IERC165 {
+    /**
+     * @notice Execution logic to be executed when a token's PMP is configured.
+     * @dev This hook is executed after the PMP is configured.
+     * @param coreContract The address of the core contract that was configured.
+     * @param tokenId The tokenId of the token that was configured.
+     * @param pmpInput The PMP input that was used to successfully configure the token.
+     */
+    function onTokenPMPConfigure(
+        address coreContract,
+        uint256 tokenId,
+        IPMPV0.PMPInput calldata pmpInput
+    ) external;
+
+    // @dev ERC156 function supportsInterface must be implemented and broadcast true for this interfaceId
+}

package/contracts/interfaces/v0.8.x/IPMPV0.sol

@@ -0,0 +1,224 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IPMPConfigureHook} from "./IPMPConfigureHook.sol";
+import {IPMPAugmentHook} from "./IPMPAugmentHook.sol";
+import {IWeb3Call} from "./IWeb3Call.sol";
+
+import {ImmutableStringArray} from "../../libs/v0.8.x/ImmutableStringArray.sol";
+
+/**
+ * @title Project Metadata Parameters (PMP) Interface, V0
+ * @author Art Blocks Inc.
+ * @notice Interface for the Project Metadata Parameters (PMP) contract that defines
+ * how projects can expose configurable parameters for tokens. This interface establishes
+ * the standard for parameter configuration, validation, and retrieval.
+ * @dev This interface extends the IWeb3Call interface to provide compatibility with
+ * existing Web3 infrastructure.
+ */
+interface IPMPV0 is IWeb3Call {
+    /**
+     * @notice Emitted when project hooks are configured.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID for which hooks were configured.
+     * @param tokenPMPPostConfigHook The hook to call after a token's PMP is configured.
+     * @param tokenPMPReadAugmentationHook The hook to call when reading a token's PMPs.
+     */
+    event ProjectHooksConfigured(
+        address coreContract,
+        uint256 projectId,
+        IPMPConfigureHook tokenPMPPostConfigHook,
+        IPMPAugmentHook tokenPMPReadAugmentationHook
+    );
+
+    /**
+     * @notice Emitted when a project's available parameters are configured.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID for which parameters were configured.
+     * @param pmpInputConfigs Array of parameter configurations defining the available parameters.
+     * @param projectConfigNonce The nonce of the project configuration.
+     */
+    event ProjectConfigured(
+        address coreContract,
+        uint256 projectId,
+        PMPInputConfig[] pmpInputConfigs,
+        uint8 projectConfigNonce
+    );
+
+    /**
+     * @notice Emitted when a token's parameters are configured.
+     * @param coreContract The address of the core contract.
+     * @param tokenId The token ID for which parameters were configured.
+     * @param pmpInputs Array of parameter inputs that were configured.
+     */
+    event TokenParamsConfigured(
+        address coreContract,
+        uint256 tokenId,
+        PMPInput[] pmpInputs
+    );
+
+    /**
+     * @notice Emitted when the delegation registry is updated.
+     * @dev At the time of writing, the delegate.xyz v2 contract is the only
+     * delegate registry contract that is supported.
+     * @param delegationRegistry The address of the new delegation registry.
+     */
+    event DelegationRegistryUpdated(address delegationRegistry);
+
+    /**
+     * @notice Defines who can configure a parameter for a token.
+     * @dev Enum ordering is relied on (ArtistAndTokenOwnerAndAddress being last).
+     */
+    enum AuthOption {
+        Artist,
+        TokenOwner,
+        Address,
+        ArtistAndTokenOwner,
+        ArtistAndAddress,
+        TokenOwnerAndAddress,
+        ArtistAndTokenOwnerAndAddress
+    }
+
+    /**
+     * @notice Defines the type of parameter that can be configured.
+     * @dev Enum ordering is relied on (String being last).
+     */
+    enum ParamType {
+        Unconfigured, // @dev default value, used to check if PMP is configured
+        Select,
+        Bool,
+        Uint256Range,
+        Int256Range,
+        DecimalRange,
+        HexColor,
+        Timestamp,
+        String // utilizes string in PMP struct, all other param types utilize the generic bytes32 param
+    }
+
+    /**
+     * @notice Structure for a parameter configuration input.
+     * @dev Used when configuring a project's available parameters.
+     */
+    struct PMPInputConfig {
+        string key; // slot 0: 32 bytes
+        PMPConfig pmpConfig; // slot 1: 32 bytes
+    }
+
+    /**
+     * @notice Structure for a parameter configuration.
+     * @dev Defines the constraints and options for a parameter.
+     */
+    struct PMPConfig {
+        AuthOption authOption; // slot 0: 1 byte
+        ParamType paramType; // slot 0: 1 byte
+        uint48 pmpLockedAfterTimestamp; // slot 0: 6 bytes
+        address authAddress; // slot 0: 20 bytes
+        string[] selectOptions; // slot 1: 32 bytes
+        // @dev use bytes32 for all range types for SSTORE efficiency
+        // @dev minRange and maxRange cast to defined numeric type when verifying assigned PMP values
+        bytes32 minRange; // slot 2: 32 bytes
+        bytes32 maxRange; // slot 3: 32 bytes
+    }
+
+    /**
+     * @notice View structure for a parameter configuration.
+     * @dev Used when reading a project's available parameters.
+     * @dev any populated select options are loaded and returned as a string array
+     * instead of remaining as a pointer to a data contract
+     */
+    struct PMPConfigView {
+        uint8 highestConfigNonce;
+        AuthOption authOption;
+        ParamType paramType;
+        uint48 pmpLockedAfterTimestamp;
+        address authAddress;
+        uint8 selectOptionsLength;
+        string[] selectOptions;
+        bytes32 minRange;
+        bytes32 maxRange;
+    }
+
+    /**
+     * @notice Structure for a parameter input.
+     * @dev Used when configuring a token's parameters.
+     */
+    struct PMPInput {
+        string key; // slot 0: 32 bytes
+        ParamType configuredParamType;
+        // @dev store values as bytes32 for efficiency, cast appropriately when reading
+        bytes32 configuredValue;
+        bool configuringArtistString;
+        string configuredValueString;
+    }
+
+    /**
+     * @notice Storage structure for a configured parameter.
+     * @dev Includes both artist and non-artist configured string values.
+     */
+    struct PMPStorage {
+        ParamType configuredParamType; // slot 0: 1 byte
+        // @dev store values as bytes32 for efficiency, cast appropriately when reading
+        bytes32 configuredValue; // slot 1: 32 bytes
+        string artistConfiguredValueString; // slot 2: 32 bytes
+        string nonArtistConfiguredValueString; // slot 3: 32 bytes
+    }
+
+    /**
+     * @notice Configure the hooks for a project.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID to configure hooks for.
+     * @param tokenPMPPostConfigHook The hook to call after a token's PMP is configured.
+     * @param tokenPMPReadAugmentationHook The hook to call when reading a token's PMPs.
+     */
+    function configureProjectHooks(
+        address coreContract,
+        uint256 projectId,
+        IPMPConfigureHook tokenPMPPostConfigHook,
+        IPMPAugmentHook tokenPMPReadAugmentationHook
+    ) external;
+
+    /**
+     * @notice Configure the available parameters for a project.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID to configure parameters for.
+     * @param pmpInputConfigs Array of parameter configurations defining the available parameters.
+     */
+    function configureProject(
+        address coreContract,
+        uint256 projectId,
+        PMPInputConfig[] calldata pmpInputConfigs
+    ) external;
+
+    /**
+     * @notice Configure the parameters for a specific token.
+     * @param coreContract The address of the core contract.
+     * @param tokenId The token ID to configure parameters for.
+     * @param pmpInputs Array of parameter inputs to configure.
+     */
+    function configureTokenParams(
+        address coreContract,
+        uint256 tokenId,
+        PMPInput[] calldata pmpInputs
+    ) external;
+
+    /**
+     * @notice Checks if the given wallet has the owner role for the given token.
+     * It returns true if the wallet is the owner of the token or if the wallet
+     * is a delegate of the token owner; otherwise it returns false.
+     * Reverts if an invalid coreContract or tokenId is provided.
+     * Provided for convenience, as the same check is performed in the
+     * configureTokenParams function.
+     * @param wallet The wallet address to check.
+     * @param coreContract The address of the core contract to call.
+     * @param tokenId The tokenId of the token to check.
+     * @return isTokenOwnerOrDelegate True if the wallet is the owner or a delegate of the token,
+     * false otherwise.
+     */
+    function isTokenOwnerOrDelegate(
+        address wallet,
+        address coreContract,
+        uint256 tokenId
+    ) external view returns (bool);
+}

package/contracts/interfaces/v0.8.x/ISeaDropShimForContract.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: MIT
+
+// @dev file adds event for indicating a shim contract compatible with SeaDrop, and points to the corresponding NFT
+// contract
+pragma solidity ^0.8.22;
+
+interface ISeaDropShimForContract {
+    /**
+     * @dev Emit event when a shim-minter compatible with SeaDrop that mints tokens on a different contract is deployed
+     * @param nftContract The address of the NFT contract that this shim contract is compatible with
+     */
+    event SeaDropShimForContract(address nftContract);
+
+    /**
+     * @dev Emit event when the local max supply is updated
+     * @param newLocalMaxSupply The new local max supply
+     */
+    event LocalMaxSupplyUpdated(uint256 newLocalMaxSupply);
+}

package/contracts/interfaces/v0.8.x/ISharedMinterMinPriceV0.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for minimum price minting.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterMinPriceV0 {
+    /**
+     * @notice Update the default minimum mint fee for the minter.
+     * @param newDefaultMinMintFee New default minimum mint fee, in wei
+     */
+    function updateDefaultMinMintFee(uint256 newDefaultMinMintFee) external;
+
+    /**
+     * @notice Get the default mint fee for the minter.
+     * @return defaultMinMintFee Default minimum mint fee, in wei
+     */
+    function defaultMinMintFee() external view returns (uint256);
+}

package/contracts/interfaces/v0.8.x/ISharedMinterRequired.sol

@@ -10,11 +10,17 @@ pragma solidity ^0.8.0;
  * interface.
  */
 interface ISharedMinterRequired {
-    // Function returns the minter type, and is called by the MinterFilter for
-    // metadata purposes.
+    /**
+     * @notice Returns the minter's type, used by the minter filter for metadata
+     * purposes.
+     * @return The minter type.
+     */
     function minterType() external view returns (string memory);
 
-    // Function returns the minter's associated shared minter filter address,
-    // and is called by subgraph indexing service for entity relation purposes.
+    /**
+     * @notice Returns the minter's associated shared minter filter address.
+     * @dev used by subgraph indexing service for entity relation purposes.
+     * @return The minter filter address.
+     */
     function minterFilterAddress() external returns (address);
 }

package/contracts/interfaces/v0.8.x/IUniversalBytecodeStorageReader.sol

@@ -0,0 +1,33 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IBytecodeStorageReader_Base} from "./IBytecodeStorageReader_Base.sol";
+
+/**
+ * @title This interface extends the IBytecodeStorageReader_Base interface with relevant events and functions used on the
+ * universal bytecode storage reader contract.
+ * @author Art Blocks Inc.
+ */
+interface IUniversalBytecodeStorageReader is IBytecodeStorageReader_Base {
+    /**
+     * @notice The active bytecode storage reader contract being used by this universal reader was updated.
+     * @param activeReader The address of the new active bytecode storage reader contract.
+     */
+    event ReaderUpdated(address indexed activeReader);
+
+    /**
+     * @notice Update the active bytecode storage reader contract being used by this universal reader.
+     * @dev emits a ReaderUpdated event when successful.
+     * @param newBytecodeStorageReaderContract The address of the new active bytecode storage reader contract.
+     */
+    function updateBytecodeStorageReaderContract(
+        IBytecodeStorageReader_Base newBytecodeStorageReaderContract
+    ) external;
+
+    function activeBytecodeStorageReaderContract()
+        external
+        view
+        returns (IBytecodeStorageReader_Base);
+}

package/contracts/interfaces/v0.8.x/IWeb3Call.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IWeb3Call {
+    /**
+     * @notice TokenParam struct defines the parameters for a given token.
+     * @param key The key of the token parameter.
+     * @param value The value of the token parameter.
+     */
+    struct TokenParam {
+        string key;
+        string value;
+    }
+
+    /**
+     * @notice Get the token parameters for a given token.
+     * If none are configured, the tokenParams should be empty.
+     * @param coreContract The address of the core contract to call.
+     * @param tokenId The tokenId of the token to get data for.
+     * @return tokenParams An array of token parameters for the queried token.
+     */
+    function getTokenParams(
+        address coreContract,
+        uint256 tokenId
+    ) external view returns (TokenParam[] memory tokenParams);
+}

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

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: MIT
+// @dev file is sourced from OpenSea's repository: https://github.com/ProjectOpenSea/seadrop/blob/main/src/lib/ERC721SeaDropStructsErrorsAndEvents.sol
+// @dev modified to not lock to specific version, as well as updated imports for this repository
+pragma solidity ^0.8.17;
+
+import {AllowListData, PublicDrop, SignedMintValidationParams, TokenGatedDropStage} from "./SeaDropStructs.sol";
+
+interface ERC721SeaDropStructsErrorsAndEvents {
+    /**
+     * @notice Revert with an error if mint exceeds the max supply.
+     */
+    error MintQuantityExceedsMaxSupply(uint256 total, uint256 maxSupply);
+
+    /**
+     * @notice Revert with an error if the number of token gated
+     *         allowedNftTokens doesn't match the length of supplied
+     *         drop stages.
+     */
+    error TokenGatedMismatch();
+
+    /**
+     *  @notice Revert with an error if the number of signers doesn't match
+     *          the length of supplied signedMintValidationParams
+     */
+    error SignersMismatch();
+
+    /**
+     * @notice An event to signify that a SeaDrop token contract was deployed.
+     */
+    event SeaDropTokenDeployed();
+
+    /**
+     * @notice A struct to configure multiple contract options at a time.
+     */
+    struct MultiConfigureStruct {
+        uint256 maxSupply;
+        string baseURI;
+        string contractURI;
+        address seaDropImpl;
+        PublicDrop publicDrop;
+        string dropURI;
+        AllowListData allowListData;
+        address creatorPayoutAddress;
+        bytes32 provenanceHash;
+        address[] allowedFeeRecipients;
+        address[] disallowedFeeRecipients;
+        address[] allowedPayers;
+        address[] disallowedPayers;
+        // Token-gated
+        address[] tokenGatedAllowedNftTokens;
+        TokenGatedDropStage[] tokenGatedDropStages;
+        address[] disallowedTokenGatedAllowedNftTokens;
+        // Server-signed
+        address[] signers;
+        SignedMintValidationParams[] signedMintValidationParams;
+        address[] disallowedSigners;
+    }
+}