@artblocks/contracts 1.0.3 → 1.0.4

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

@@ -0,0 +1,78 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface adds support for serial English auction minting.
+ * @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
+    );
+}

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

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Art Blocks Shared Minter Simple Purchase Interface
+ * @notice This interface is designed to be used by minter contracts that
+ * implement a simple purchase model, such that the only args required to
+ * purchase a token are the project id and the core contract address, and an
+ * optional recipient address.
+ */
+interface ISharedMinterSimplePurchaseV0 {
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address.
+    function purchase(
+        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
+    ) external payable returns (uint256 tokenId);
+}

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

@@ -0,0 +1,191 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+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
+    );
+
+    // 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
+    ) external;
+
+    // Called to make the minter contract aware of the max invocations for a
+    // given project.
+    function syncProjectMaxInvocationsToCore(
+        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
+    )
+        external
+        view
+        returns (
+            bool isConfigured,
+            uint256 tokenPriceInWei,
+            string memory currencySymbol,
+            address currencyAddress
+        );
+}

package/contracts/interfaces/{0.8.x → v0.8.x}/ISharedRandomizerV0.sol

@@ -15,58 +15,68 @@ interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
     );
 
     /**
-     * @notice Minter contract at `_hashSeedSetterContract` allowed to assign
-     * token hash seeds on core contract `_coreContract`.
+     * @notice Contract at `_hashSeedSetterContract` allowed to assign
+     * token hash seeds on core contract `_coreContract` for project
+     * `_projectId`.
      */
-    event HashSeedSetterForCoreUpdated(
+    event HashSeedSetterForProjectUpdated(
         address indexed coreContract,
+        uint256 indexed projectId,
         address indexed hashSeedSetterContract
     );
 
     /**
-     * @notice Project with ID `_projectId` is enabled/disabled for polyptych
-     * minting (i.e. allows token hash seeds to be set by hash seed setter).
+     * @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 ProjectIsPolyptychUpdated(
+    event ProjectUsingHashSeedSetterUpdated(
         address coreContract,
         uint256 projectId,
-        bool isPolyptych
+        bool usingHashSeedSetter
     );
 
     /**
-     * @notice Allows the owner of a core contract to set the contract that is
+     * @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
      * hash seeds to tokens
      */
     function setHashSeedSetterContract(
         address _coreContract,
+        uint256 _projectId,
         address _hashSeedSetterContract
     ) external;
 
     /**
-     * @notice Allows the artist of a project to configure as as a polyptych
-     * project.
+     * @notice Allows the artist of a project to configure their project to
+     * only allow the specified hash seed setter contract to assign new token
+     * hash seeds. When this is enabled, the hash seed setter contract is
+     * responsible for assigning hash seeds to tokens, and the randomizer
+     * contract will not use the pseudorandom atomic contract to generate
+     * hash seeds.
+     * 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 that has a polyptych panel
-     * (second, third, etc.)
+     * @param _projectId - The ID of the project to be toggled
      */
-    function toggleProjectIsPolyptych(
+    function toggleProjectUseAssignedHashSeed(
         address _coreContract,
         uint256 _projectId
     ) external;
 
     /**
-     * @notice Store the token hash seed for an existing token to be re-used in
-     * a polyptych panel.
+     * @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`.
      */
-    function setPolyptychHashSeed(
+    function preSetHashSeed(
         address _coreContract,
         uint256 _tokenId,
         bytes12 _hashSeed
@@ -74,31 +84,39 @@ interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
 
     /**
      * @notice Boolean representing whether or not project with ID `_projectId`
-     * on core contract `_coreContract` is currently enabled for polyptych
-     * minting.
+     * on core contract `_coreContract` is currently using a hash seed setter
+     * contract to assign hash seeds to tokens.
      */
-    function projectIsPolyptych(
+    function projectUsesHashSeedSetter(
         address _coreContract,
         uint256 _projectId
-    ) external view returns (bool _isPolyptych);
+    ) 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
      */
     function hashSeedSetterContracts(
-        address _coreContract
+        address _coreContract,
+        uint256 _projectId
     ) external view returns (address _hashSeedSetterContract);
 
     /**
-     * Returns the current hash seed for a given token ID.
-     * Returns bytes12(0) if no hash seed is set for the token.
+     * Returns the current pre-assigned hash seed for a given token ID.
+     * Returns bytes12(0) if no hash seed has been set for the token.
+     * Note that this only returns the pre-assigned hash seed for tokens that
+     * are configured to use a hash seed setter contract. In typical cases
+     * where the project is not configured to use a hash seed setter contract,
+     * 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`
      */
-    function polyptychHashSeed(
+    function preAssignedHashSeed(
         address _coreContract,
         uint256 _tokenId
     ) external view returns (bytes12 _hashSeed);

package/contracts/legacy/GenArt721CoreV1.sol

@@ -7,8 +7,8 @@
  *   maintains conforming V1 core contract interface
  */
 
-import "../interfaces/0.5.x/IRandomizer.sol";
-import "../interfaces/0.5.x/IGenArt721CoreContractV1.sol";
+import "../interfaces/v0.5.x/IRandomizer.sol";
+import "../interfaces/v0.5.x/IGenArt721CoreContractV1.sol";
 
 /// -----------------------------------------------------
 /**

package/contracts/legacy/GenArt721LegacyMinter.sol

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Creatd By: Art Blocks Inc.
 
-import "../libs/0.5.x/SafeMath.sol";
-import "../libs/0.5.x/Strings.sol";
-import "../libs/0.5.x/IERC20.sol";
+import "../libs/v0.5.x/SafeMath.sol";
+import "../libs/v0.5.x/Strings.sol";
+import "../libs/v0.5.x/IERC20.sol";
 
-import "../interfaces/0.5.x/IGenArt721CoreContractV1.sol";
-import "../interfaces/0.5.x/IBonusContract.sol";
+import "../interfaces/v0.5.x/IGenArt721CoreContractV1.sol";
+import "../interfaces/v0.5.x/IBonusContract.sol";
 
 pragma solidity ^0.5.0;
 

package/contracts/libs/integration-refs/delegation-registry/DelegationRegistry.sol

@@ -5,7 +5,7 @@ pragma solidity ^0.8.19;
 // The source code is copied from ETH mainnet, deployed at:0x00000000000076a84fef008cdabe6409d2fe638b
 // Updates are made to imports for compatibility with this repo.
 
-import "../../../interfaces/0.8.x/IDelegationRegistry.sol";
+import "../../../interfaces/v0.8.x/IDelegationRegistry.sol";
 import "@openzeppelin-4.7/contracts/utils/structs/EnumerableSet.sol";
 import "@openzeppelin-4.7/contracts/utils/introspection/ERC165.sol";
 

package/contracts/libs/v0.8.x/ABHelpers.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Art Blocks Helpers Library
+ * @notice This library contains helper functions for common operations in the
+ * Art Blocks ecosystem of smart contracts.
+ * @author Art Blocks Inc.
+ */
+
+library ABHelpers {
+    uint256 constant ONE_MILLION = 1_000_000;
+
+    /**
+     * Convert token id to project id.
+     * @param _tokenId The id of the token.
+     */
+    function tokenIdToProjectId(
+        uint256 _tokenId
+    ) internal pure returns (uint256) {
+        // int division properly rounds down
+        // @dev unchecked because will never divide by zero
+        unchecked {
+            return _tokenId / ONE_MILLION;
+        }
+    }
+
+    /**
+     * Convert token id to token number.
+     * @param _tokenId The id of the token.
+     */
+    function tokenIdToTokenNumber(
+        uint256 _tokenId
+    ) internal pure returns (uint256) {
+        // mod returns remainder, which is the token number
+        // @dev no way to disable mod zero check in solidity, so not unchecked
+        return _tokenId % ONE_MILLION;
+    }
+
+    /**
+     * Convert project id and token number to token id.
+     * @param _projectId The id of the project.
+     * @param _tokenNumber The token number.
+     */
+    function tokenIdFromProjectIdAndTokenNumber(
+        uint256 _projectId,
+        uint256 _tokenNumber
+    ) internal pure returns (uint256) {
+        // @dev intentionally not unchecked to ensure overflow detection, which
+        // would likley only occur in a malicious call
+        return (_projectId * ONE_MILLION) + _tokenNumber;
+    }
+}