@artblocks/contracts 1.1.0 → 1.2.1

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/IGenArt721Minter_PBAB.sol

@@ -0,0 +1,91 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IGenArt721Minter_PBAB {
+    /**
+     * @notice Price per token in wei updated for project `_projectId` to
+     * `_pricePerTokenInWei`.
+     */
+    event PricePerTokenInWeiUpdated(
+        uint256 indexed _projectId,
+        uint256 indexed _pricePerTokenInWei
+    );
+
+    /**
+     * @notice Currency updated for project `_projectId` to symbol
+     * `_currencySymbol` and address `_currencyAddress`.
+     */
+    event ProjectCurrencyInfoUpdated(
+        uint256 indexed _projectId,
+        address indexed _currencyAddress,
+        string _currencySymbol
+    );
+
+    /// togglePurchaseToDisabled updated
+    event PurchaseToDisabledUpdated(
+        uint256 indexed _projectId,
+        bool _purchaseToDisabled
+    );
+
+    // getter function of public variable
+    function minterType() external view returns (string memory);
+
+    function genArt721CoreAddress() external returns (address);
+
+    function minterFilterAddress() external returns (address);
+
+    // Triggers a purchase of a token from the desired project with ETH, to the
+    // TX-sending address.
+    function purchase(
+        uint256 _projectId
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project with ETH or any ERC-20 token, to the
+    // TX-sending address.
+    function purchase(
+        uint256 _projectId,
+        uint256 _maxPricePerToken,
+        address _currencyAddress
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project with ETH, to the specified
+    // receiving address.
+    function purchaseTo(
+        address _to,
+        uint256 _projectId
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project with ETH or any ERC-20 token, to the specified
+    // receiving address.
+    function purchaseTo(
+        address _to,
+        uint256 _projectId,
+        uint256 _maxPricePerToken,
+        address _currencyAddress
+    ) external payable returns (uint256 tokenId);
+
+    // Toggles the ability for `purchaseTo` to be called directly with a
+    // specified receiving address that differs from the TX-sending address.
+    function togglePurchaseToDisabled(uint256 _projectId) external;
+
+    // Called to make the minter contract aware of the max invocations for a
+    // given project.
+    function setProjectMaxInvocations(uint256 _projectId) external;
+
+    // Gets if token price is configured, token price in wei, currency symbol,
+    // and currency address, assuming this is project's minter.
+    // Supersedes any defined core price.
+    function getPriceInfo(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            bool isConfigured,
+            uint256 tokenPriceInWei,
+            string memory currencySymbol,
+            address currencyAddress
+        );
+}

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/IPseudorandomAtomic.sol

@@ -10,7 +10,5 @@ interface IPseudorandomAtomic {
      * generation process. An example of entropy might be the hash of a core
      * contract's address, and the ID of the token being generated.
      */
-    function getPseudorandomAtomic(
-        bytes32 _entropy
-    ) external view returns (bytes32);
+    function getPseudorandomAtomic(bytes32 _entropy) external returns (bytes32);
 }

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/ISharedMinterDAExpSettlementV0.sol

@@ -25,4 +25,23 @@ interface ISharedMinterDAExpSettlementV0 is ISharedMinterDAExpV0 {
         address coreContract,
         address walletAddress
     ) external view returns (uint256 excessSettlementFundsInWei);
+
+    /**
+     * @notice Reclaims the sender's payment above current settled price for
+     * project `projectId` on core contract `coreContract`.
+     * The current settled price is the price paid for the most recently
+     * purchased token, or the base price if the artist has withdrawn revenues
+     * after the auction reached base price.
+     * This function is callable at any point, but is expected to typically be
+     * called after auction has sold out above base price or after the auction
+     * has been purchased at base price. This minimizes the amount of gas
+     * required to send all excess settlement funds to the sender.
+     * Sends excess settlement funds to msg.sender.
+     * @param projectId Project ID to reclaim excess settlement funds on.
+     * @param coreContract Contract address of the core contract
+     */
+    function reclaimProjectExcessSettlementFunds(
+        uint256 projectId,
+        address coreContract
+    ) external;
 }

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/ISharedMinterRAMV0.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for ranked auction minting.
+ * @author Art Blocks Inc.
+ */
+interface ISharedMinterRAMV0 {
+    function createBid(
+        uint256 projectId,
+        address coreContract,
+        uint16 slotIndex
+    ) external payable;
+
+    function topUpBid(
+        uint256 projectId,
+        address coreContract,
+        uint32 bidId,
+        uint16 newSlotIndex
+    ) external payable;
+}

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

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title ISharedMinterRequired
+ * @notice This interface contains the minimum required interface for a shared
+ * minter contract. All custom, one-off minter contracts should implement this
+ * interface.
+ */
+interface ISharedMinterRequired {
+    /**
+     * @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);
+
+    /**
+     * @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/ISharedMinterSEAV0.sol

@@ -8,8 +8,5 @@ pragma solidity ^0.8.0;
  * @author Art Blocks Inc.
  */
 interface ISharedMinterSEAV0 {
-    function createBid(
-        uint256 projectId,
-        address coreContract
-    ) external payable;
+    function createBid(uint256 tokenId, address coreContract) external payable;
 }

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

@@ -3,7 +3,18 @@
 
 pragma solidity ^0.8.0;
 
-interface ISharedMinterV0 {
+import {ISharedMinterRequired} from "./ISharedMinterRequired.sol";
+
+/**
+ * @title ISharedMinterV0
+ * @notice This interface extends the minimum required interface for a shared
+ * minter contract to add additional functionality that is generally available
+ * for all shared minter contracts on the shared minter filter.
+ * @dev Custom, one-off minter contracts that are not globally approved may
+ * choose to not implement this interface, but should still implement the
+ * ISharedMinterRequired interface.
+ */
+interface ISharedMinterV0 is ISharedMinterRequired {
     // Sets the local max invocations for a given project, checking that the provided max invocations is
     // less than or equal to the global max invocations for the project set on the core contract.
     // This does not impact the max invocations value defined on the core contract.
@@ -20,11 +31,6 @@ interface ISharedMinterV0 {
         address coreContract
     ) external;
 
-    // getter function of public variable
-    function minterType() external view returns (string memory);
-
-    function minterFilterAddress() external returns (address);
-
     // Gets if token price is configured, token price in wei, currency symbol,
     // and currency address, assuming this is project's minter.
     // Supersedes any defined core price.

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

@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {Split} from "./ISplitAtomicV0.sol";
+
+interface ISplitAtomicFactoryV0 {
+    /**
+     * @notice This contract was deployed.
+     * @param implementation address with the implementation of the contract
+     * @param type_ type of this contract
+     * @param requiredSplitAddress address that must be included in all splits
+     * @param requiredSplitBasisPoints basis points that must be included in
+     * all splits
+     */
+    event Deployed(
+        address indexed implementation,
+        bytes32 indexed type_,
+        address requiredSplitAddress,
+        uint16 requiredSplitBasisPoints
+    );
+    /**
+     * @notice New split atomic contract was created.
+     * @param splitAtomic address of the newly created split atomic contract
+     */
+    event SplitAtomicCreated(address indexed splitAtomic);
+    /**
+     * @notice This contract was abandoned and no longer can be used to create
+     * new split atomic contracts.
+     */
+    event Abandoned();
+
+    /**
+     * @notice Initializes the contract with the provided `splits`.
+     * Only callable once.
+     * @param splits Splits to configure the contract with. Must add up to
+     * 10_000 BPS.
+     * @return splitAtomic The address of the newly created split atomic
+     * contract
+     */
+    function createSplit(
+        Split[] calldata splits
+    ) external returns (address splitAtomic);
+
+    /**
+     * @notice The implementation contract that is cloned when creating new
+     * split atomic contracts.
+     */
+    function splitAtomicImplementation() external view returns (address);
+
+    /**
+     * @notice The address that must be included in all splits.
+     */
+    function requiredSplitAddress() external view returns (address);
+
+    /**
+     * @notice The basis points that must be included in all splits, for the
+     * required split address.
+     */
+    function requiredSplitBasisPoints() external view returns (uint16);
+
+    /**
+     * @notice The deployer of the contract.
+     */
+    function deployer() external view returns (address);
+
+    /**
+     * @notice Indicates whether the contract is abandoned.
+     * Once abandoned, the contract can no longer be used to create new split
+     * atomic contracts.
+     * @return bool True if the contract is abandoned, false otherwise.
+     */
+    function isAbandoned() external view returns (bool);
+
+    /**
+     * @notice Indicates the type of the contract, e.g. `SplitAtomicFactoryV0`.
+     * @return type_ The type of the contract.
+     */
+    function type_() external pure returns (bytes32);
+}

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

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @notice Struct representing a split.
+ * @param recipient The address to send funds to.
+ * @param basisPoints The basis points to allocate to recipient (1-10_000).
+ */
+struct Split {
+    // address to send funds to
+    address payable recipient;
+    // basis points to allocate to recipient (1-10_000)
+    uint16 basisPoints;
+}
+
+interface ISplitAtomicV0 {
+    /**
+     * @notice Indicates that the contract has been initialized.
+     * @param type_ The type of the contract.
+     */
+    event Initialized(bytes32 type_);
+
+    /**
+     * @notice Indicates that the contract's balance manually was drained of
+     * ETH.
+     */
+    event DrainedETH();
+
+    /**
+     * @notice Indicates that the contract's balance manually was drained of
+     * ERC20 token at address `ERC20TokenAddress`.
+     * @param ERC20TokenAddress The address of the ERC20 token that was
+     * drained.
+     */
+    event DrainedERC20(address ERC20TokenAddress);
+
+    /**
+     * @notice Initializes the contract with the provided `splits`.
+     * This function should be called atomically, immediately after deployment.
+     * Only callable once.
+     * @param splits Splits to configure the contract with. Must add up to
+     * 10_000 BPS.
+     */
+    function initialize(Split[] calldata splits) external;
+
+    /**
+     * @notice Drains the contract's ETH balance to the configured `splits`.
+     * Reverts if not initialized.
+     */
+    function drainETH() external;
+
+    /**
+     * @notice Drains the contract's balance of an input ERC20 token to the
+     * configured `splits`. Reverts if not initialized.
+     * @param ERC20TokenAddress The address of the ERC20 token to split.
+     */
+    function drainERC20(address ERC20TokenAddress) external;
+
+    /**
+     * @notice Returns the configured `splits`.
+     * @return Split[] memory The configured `splits`.
+     */
+    function getSplits() external view returns (Split[] memory);
+
+    /**
+     * @notice Indicates the type of the contract, e.g. `SplitAtomicV0`.
+     * @return type_ The type of the contract.
+     */
+    function type_() external pure returns (bytes32);
+}

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

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {ISplitFactoryV2} from "./integration-refs/splits-0x-v2/ISplitFactoryV2.sol";
+
+interface ISplitProviderV0 {
+    /**
+     * @notice SplitInputs struct defines the inputs for requested splitters.
+     * It is defined in a way easily communicated from the Art Blocks GenArt721V3 contract,
+     * to allow for easy integration and minimal additional bytecode in the GenArt721V3 contract.
+     */
+    struct SplitInputs {
+        address platformProviderSecondarySalesAddress;
+        uint16 platformProviderSecondarySalesBPS;
+        address renderProviderSecondarySalesAddress;
+        uint16 renderProviderSecondarySalesBPS;
+        uint8 artistTotalRoyaltyPercentage;
+        address artist;
+        address additionalPayee;
+        uint8 additionalPayeePercentage;
+    }
+
+    /**
+     * @notice Emitted when a new splitter contract is created.
+     * @param splitter address of the splitter contract
+     */
+    event SplitterCreated(address indexed splitter);
+
+    /**
+     * @notice Gets or creates an immutable splitter contract at a deterministic address.
+     * Splits in the splitter contract are determined by the input split parameters,
+     * so we can safely create the splitter contract at a deterministic address (or use
+     * the existing splitter contract if it already exists at that address).
+     * @dev Uses the 0xSplits v2 implementation to create a splitter contract
+     * @param splitInputs The split input parameters.
+     * @return splitter The newly created splitter contract address.
+     */
+    function getOrCreateSplitter(
+        SplitInputs calldata splitInputs
+    ) external returns (address);
+
+    /**
+     * @notice Indicates the type of the contract, e.g. `SplitProviderV0`.
+     * @return type_ The type of the contract.
+     */
+    function type_() external pure returns (bytes32);
+}

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

@@ -0,0 +1,28 @@
+// 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;
+}

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;
+    }
+}