@artblocks/contracts 1.0.4 → 1.2.0

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

@@ -0,0 +1,20 @@
+// 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 {
+    // Function returns the minter type, and is called by the MinterFilter for
+    // metadata purposes.
+    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.
+    function minterFilterAddress() external returns (address);
+}

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

@@ -8,71 +8,5 @@ pragma solidity ^0.8.0;
  * @author Art Blocks Inc.
  */
 interface ISharedMinterSEAV0 {
-    /**
-     * @notice Minimum auction length, in seconds, was updated to be the
-     * provided value.
-     */
-    event MinAuctionDurationSecondsUpdated(uint256 minAuctionDurationSeconds);
-
-    /// Admin-controlled time buffer updated
-    event MinterTimeBufferUpdated(uint32 minterTimeBufferSeconds);
-
-    // Admin-controlled refund gas limit updated
-    event MinterRefundGasLimitUpdated(uint24 refundGasLimit);
-
-    /// Artist configured future auction details
-    event ConfiguredFutureAuctions(
-        uint256 indexed projectId,
-        address indexed coreContract,
-        uint64 timestampStart,
-        uint32 auctionDurationSeconds,
-        uint256 basePrice,
-        uint8 minBidIncrementPercentage
-    );
-
-    /// New token auction created, token created and sent to minter
-    event AuctionInitialized(
-        uint256 indexed tokenId,
-        address indexed coreContract,
-        address indexed bidder,
-        uint256 bidAmount,
-        uint64 endTime,
-        uint8 minBidIncrementPercentage
-    );
-
-    /// Successful bid placed on token auction
-    event AuctionBid(
-        uint256 indexed tokenId,
-        address indexed coreContract,
-        address indexed bidder,
-        uint256 bidAmount
-    );
-
-    /// Token auction was settled (token distributed to winner)
-    event AuctionSettled(
-        uint256 indexed tokenId,
-        address indexed coreContract,
-        address indexed winner,
-        uint256 price
-    );
-
-    /// Future auction details for project `projectId` reset
-    event ResetAuctionDetails(
-        uint256 indexed projectId,
-        address indexed coreContract
-    );
-
-    // Next token ID for project `projectId` updated
-    event ProjectNextTokenUpdated(
-        uint256 indexed projectId,
-        address indexed coreContract,
-        uint256 tokenId
-    );
-
-    // Next token ID for project `projectId` was ejected from the minter
-    // and is no longer populated
-    event ProjectNextTokenEjected(
-        uint256 indexed projectId,
-        address indexed coreContract
-    );
+    function createBid(uint256 tokenId, address coreContract) external payable;
 }

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

@@ -14,15 +14,15 @@ interface ISharedMinterSimplePurchaseV0 {
     // Triggers a purchase of a token from the desired project, to the
     // TX-sending address.
     function purchase(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        address coreContract
     ) external payable returns (uint256 tokenId);
 
     // Triggers a purchase of a token from the desired project, to the specified
     // receiving address.
     function purchaseTo(
-        address _to,
-        uint256 _projectId,
-        address _coreContract
+        address to,
+        uint256 projectId,
+        address coreContract
     ) external payable returns (uint256 tokenId);
 }

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

@@ -3,182 +3,40 @@
 
 pragma solidity ^0.8.0;
 
-interface ISharedMinterV0 {
-    // This section defines events for generic project minter configuration updates
-    /**
-     * @dev Strings not supported. Recommend conversion of (short) strings to
-     * bytes32 to remain gas-efficient.
-     */
-    /**
-     * @notice Generic project minter configuration event. Removes key `_key`
-     * for project `_projectId`.
-     */
-    event ConfigKeyRemoved(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key
-    );
-    /// BOOL
-    /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `_key` to `_value` for project `_projectId`.
-     */
-    event ConfigValueSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        bool _value
-    );
-    /// UINT256
-    /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `_key` to `_value` for project `_projectId`.
-     */
-    event ConfigValueSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        uint256 _value
-    );
-    /**
-     * @notice Generic project minter configuration event. Adds value `_value`
-     * to the set of uint256 at key `_key` for project `_projectId`.
-     */
-    event ConfigValueAddedToSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        uint256 _value
-    );
-    /**
-     * @notice Generic project minter configuration event. Removes value
-     * `_value` to the set of uint256 at key `_key` for project `_projectId`.
-     */
-    event ConfigValueRemovedFromSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        uint256 _value
-    );
-    /// ADDRESS
-    /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `_key` to `_value` for project `_projectId`.
-     */
-    event ConfigValueSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        address _value
-    );
-    /**
-     * @notice Generic project minter configuration event. Adds value `_value`
-     * to the set of addresses at key `_key` for project `_projectId`.
-     */
-    event ConfigValueAddedToSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        address _value
-    );
-    /**
-     * @notice Generic project minter configuration event. Removes value
-     * `_value` to the set of addresses at key `_key` for project `_projectId`.
-     */
-    event ConfigValueRemovedFromSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        address _value
-    );
-    /// BYTES32
-    /**
-     * @notice Generic project minter configuration event. Sets value of key
-     * `_key` to `_value` for project `_projectId`.
-     */
-    event ConfigValueSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        bytes32 _value
-    );
-    /**
-     * @notice Generic project minter configuration event. Adds value `_value`
-     * to the set of bytes32 at key `_key` for project `_projectId`.
-     */
-    event ConfigValueAddedToSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        bytes32 _value
-    );
-    /**
-     * @notice Generic project minter configuration event. Removes value
-     * `_value` to the set of bytes32 at key `_key` for project `_projectId`.
-     */
-    event ConfigValueRemovedFromSet(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        bytes32 _key,
-        bytes32 _value
-    );
-    ///////////////////////////
-    /**
-     * @notice Price per token in wei updated for project `_projectId` to
-     * `_pricePerTokenInWei`.
-     */
-    event PricePerTokenInWeiUpdated(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        uint256 indexed _pricePerTokenInWei
-    );
-    /**
-     * @notice Currency updated for project `_projectId` to symbol
-     * `_currencySymbol` and address `_currencyAddress`.
-     */
-    event ProjectCurrencyInfoUpdated(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        address indexed _currencyAddress,
-        string _currencySymbol
-    );
-    /**
-     * @notice Local max invocations for project `_projectId`, tied to core contract `_coreContractAddress`,
-     * updated to `_maxInvocations`.
-     */
-    event ProjectMaxInvocationsLimitUpdated(
-        uint256 indexed _projectId,
-        address indexed _coreContract,
-        uint256 _maxInvocations
-    );
+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.
     function manuallyLimitProjectMaxInvocations(
-        uint256 _projectId,
-        address _coreContract,
-        uint24 _maxInvocations
+        uint256 projectId,
+        address coreContract,
+        uint24 maxInvocations
     ) external;
 
     // Called to make the minter contract aware of the max invocations for a
     // given project.
     function syncProjectMaxInvocationsToCore(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        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.
     function getPriceInfo(
-        uint256 _projectId,
-        address _coreContract
+        uint256 projectId,
+        address coreContract
     )
         external
         view

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

@@ -15,9 +15,9 @@ interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
     );
 
     /**
-     * @notice Contract at `_hashSeedSetterContract` allowed to assign
-     * token hash seeds on core contract `_coreContract` for project
-     * `_projectId`.
+     * @notice Contract at `hashSeedSetterContract` allowed to assign
+     * token hash seeds on core contract `coreContract` for project
+     * `projectId`.
      */
     event HashSeedSetterForProjectUpdated(
         address indexed coreContract,
@@ -26,7 +26,7 @@ interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
     );
 
     /**
-     * @notice Project with ID `_projectId` is is or is not using a hash seed
+     * @notice Project with ID `projectId` is is or is not using a hash seed
      * setter contract to assign token hash seeds on core contract.
      */
     event ProjectUsingHashSeedSetterUpdated(
@@ -39,15 +39,15 @@ interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
      * @notice Allows the artist of a project to set the contract that is
      * allowed to assign hash seeds to tokens. Typically, this is expected to
      * be a minter contract, such as `MinterPolyptychV1`.
-     * @param _coreContract - the core contract that is being configured
-     * @param _projectId - the project ID that is being configured
-     * @param _hashSeedSetterContract - the contract that is allowed to assign
+     * @param coreContract - the core contract that is being configured
+     * @param projectId - the project ID that is being configured
+     * @param hashSeedSetterContract - the contract that is allowed to assign
      * hash seeds to tokens
      */
     function setHashSeedSetterContract(
-        address _coreContract,
-        uint256 _projectId,
-        address _hashSeedSetterContract
+        address coreContract,
+        uint256 projectId,
+        address hashSeedSetterContract
     ) external;
 
     /**
@@ -60,48 +60,48 @@ interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
      * An example use case is where the artist wants to mint a polyptych panel
      * (second, third, etc.) of a project, and therefore wants to re-use
      * specific hash seeds of the original project.
-     * @param _coreContract - The address of the core contract
-     * @param _projectId - The ID of the project to be toggled
+     * @param coreContract - The address of the core contract
+     * @param projectId - The ID of the project to be toggled
      */
     function toggleProjectUseAssignedHashSeed(
-        address _coreContract,
-        uint256 _projectId
+        address coreContract,
+        uint256 projectId
     ) external;
 
     /**
      * @notice Pre-set the hash seed for a token. This function is only
      * callable by the hash seed setter contract of the project.
-     * @param _coreContract - The address of the core contract of `_tokenId`
-     * @param _tokenId - The ID of the token to set the hash seed for
-     * @param _hashSeed - The hash seed to set for `_tokenId`
-     * @dev Only callable by the hash seed setter contract of `_coreContract`.
+     * @param coreContract - The address of the core contract of `tokenId`
+     * @param tokenId - The ID of the token to set the hash seed for
+     * @param hashSeed - The hash seed to set for `tokenId`
+     * @dev Only callable by the hash seed setter contract of `coreContract`.
      */
     function preSetHashSeed(
-        address _coreContract,
-        uint256 _tokenId,
-        bytes12 _hashSeed
+        address coreContract,
+        uint256 tokenId,
+        bytes12 hashSeed
     ) external;
 
     /**
-     * @notice Boolean representing whether or not project with ID `_projectId`
-     * on core contract `_coreContract` is currently using a hash seed setter
+     * @notice Boolean representing whether or not project with ID `projectId`
+     * on core contract `coreContract` is currently using a hash seed setter
      * contract to assign hash seeds to tokens.
      */
     function projectUsesHashSeedSetter(
-        address _coreContract,
-        uint256 _projectId
-    ) external view returns (bool _usingHashSeedSetter);
+        address coreContract,
+        uint256 projectId
+    ) external view returns (bool usingHashSeedSetter);
 
     /**
      * Returns the hash seed setter contract for a given core contract.
      * Returns address(0) if no hash seed setter contract is set for the core.
-     * @param _coreContract - The address of the core contract
-     * @param _projectId - The ID of the project to query
+     * @param coreContract - The address of the core contract
+     * @param projectId - The ID of the project to query
      */
     function hashSeedSetterContracts(
-        address _coreContract,
-        uint256 _projectId
-    ) external view returns (address _hashSeedSetterContract);
+        address coreContract,
+        uint256 projectId
+    ) external view returns (address hashSeedSetterContract);
 
     /**
      * Returns the current pre-assigned hash seed for a given token ID.
@@ -112,12 +112,12 @@ interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
      * the hash seed is generated on-chain by the pseudorandom atomic contract
      * and is not stored on-chain in this randomizer contract, and therefore
      * this function will return bytes12(0).
-     * @param _coreContract - The address of the core contract of `_tokenId`
-     * @param _tokenId - The ID of the token to get the hash seed for
-     * @return _hashSeed - The stored hash seed for `_tokenId`
+     * @param coreContract - The address of the core contract of `tokenId`
+     * @param tokenId - The ID of the token to get the hash seed for
+     * @return hashSeed - The stored hash seed for `tokenId`
      */
     function preAssignedHashSeed(
-        address _coreContract,
-        uint256 _tokenId
-    ) external view returns (bytes12 _hashSeed);
+        address coreContract,
+        uint256 tokenId
+    ) external view returns (bytes12 hashSeed);
 }

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