@artblocks/contracts 1.0.4 → 1.1.0

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

@@ -4,168 +4,20 @@
 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
+        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
@@ -177,8 +29,8 @@ interface ISharedMinterV0 {
     // 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/libs/v0.8.x/ABHelpers.sol

@@ -14,42 +14,42 @@ library ABHelpers {
     uint256 constant ONE_MILLION = 1_000_000;
 
     /**
-     * Convert token id to project id.
-     * @param _tokenId The id of the token.
+     * @notice Function to convert token id to project id.
+     * @param tokenId The id of the token.
      */
     function tokenIdToProjectId(
-        uint256 _tokenId
+        uint256 tokenId
     ) internal pure returns (uint256) {
         // int division properly rounds down
         // @dev unchecked because will never divide by zero
         unchecked {
-            return _tokenId / ONE_MILLION;
+            return tokenId / ONE_MILLION;
         }
     }
 
     /**
-     * Convert token id to token number.
-     * @param _tokenId The id of the token.
+     * @notice Function to convert token id to token number.
+     * @param tokenId The id of the token.
      */
     function tokenIdToTokenNumber(
-        uint256 _tokenId
+        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;
+        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.
+     * @notice Function to 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
+        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;
+        return (projectId * ONE_MILLION) + tokenNumber;
     }
 }

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

@@ -3,8 +3,8 @@
 
 pragma solidity ^0.8.0;
 
-import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
-import "../../interfaces/v0.8.x/IMinterFilterV1.sol";
+import {IGenArt721CoreContractV3_Base} from "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
+import {IMinterFilterV1} from "../../interfaces/v0.8.x/IMinterFilterV1.sol";
 
 /**
  * @title Art Blocks Authorization Minter Library
@@ -16,111 +16,110 @@ import "../../interfaces/v0.8.x/IMinterFilterV1.sol";
 
 library AuthLib {
     /**
-     * function to restrict access to only AdminACL allowed calls, where
+     * @notice Function to restrict access to only AdminACL allowed calls, where
      * AdminACL is the admin of an IMinterFilterV1.
      * Reverts if not allowed.
-     * @param _minterFilterAddress address of the minter filter to be checked,
+     * @param minterFilterAddress address of the minter filter to be checked,
      * should implement IMinterFilterV1
-     * @param _sender address of the caller
-     * @param _contract address of the contract being called
-     * @param _selector selector of the function being called
+     * @param sender address of the caller
+     * @param contract_ address of the contract being called
+     * @param selector selector of the function being called
      */
     function onlyMinterFilterAdminACL(
-        address _minterFilterAddress,
-        address _sender,
-        address _contract,
-        bytes4 _selector
+        address minterFilterAddress,
+        address sender,
+        address contract_,
+        bytes4 selector
     ) internal {
         require(
             _minterFilterAdminACLAllowed({
-                _minterFilterAddress: _minterFilterAddress,
-                _sender: _sender,
-                _contract: _contract,
-                _selector: _selector
+                minterFilterAddress: minterFilterAddress,
+                sender: sender,
+                contract_: contract_,
+                selector: selector
             }),
             "Only MinterFilter AdminACL"
         );
     }
 
     /**
-     * Function to restrict access to only AdminACL allowed calls, where
-     * AdminACL is the admin of a core contract at `_coreContract`.
+     * @notice Function to restrict access to only AdminACL allowed calls, where
+     * AdminACL is the admin of a core contract at `coreContract`.
      * Reverts if not allowed.
-     * @param _coreContract address of the core contract to be checked
-     * @param _sender address of the caller
-     * @param _contract address of the contract being called
-     * @param _selector selector of the function being called
+     * @param coreContract address of the core contract to be checked
+     * @param sender address of the caller
+     * @param contract_ address of the contract being called
+     * @param selector selector of the function being called
      */
     function onlyCoreAdminACL(
-        address _coreContract,
-        address _sender,
-        address _contract,
-        bytes4 _selector
+        address coreContract,
+        address sender,
+        address contract_,
+        bytes4 selector
     ) internal {
         require(
             _coreAdminACLAllowed({
-                _coreContract: _coreContract,
-                _sender: _sender,
-                _contract: _contract,
-                _selector: _selector
+                coreContract: coreContract,
+                sender: sender,
+                contract_: contract_,
+                selector: selector
             }),
             "Only Core AdminACL allowed"
         );
     }
 
     /**
-     * @notice Throws if `_sender` is any account other than the artist of the
-     * specified project `_projectId` on core contract `_coreContract`.
-     * Requirements: `msg.sender` must be the artist associated with
-     * `_projectId` on `_coreContract`.
-     * @param _projectId The ID of the project being checked.
-     * @param _coreContract The address of the GenArt721CoreContractV3_Base
+     * @notice Throws if `sender` is any account other than the artist of the
+     * specified project `projectId` on core contract `coreContract`.
+     * @param projectId The ID of the project being checked.
+     * @param coreContract The address of the GenArt721CoreContractV3_Base
      * contract.
-     * @param _sender Wallet to check. Typically, the address of the caller.
+     * @param sender Wallet to check. Typically, the address of the caller.
+     * @dev `sender` must be the artist associated with `projectId` on `coreContract`.
      */
     function onlyArtist(
-        uint256 _projectId,
-        address _coreContract,
-        address _sender
+        uint256 projectId,
+        address coreContract,
+        address sender
     ) internal view {
         require(
             _senderIsArtist({
-                _projectId: _projectId,
-                _coreContract: _coreContract,
-                _sender: _sender
+                projectId: projectId,
+                coreContract: coreContract,
+                sender: sender
             }),
             "Only Artist"
         );
     }
 
     /**
-     * function to restrict access to only the artist of a project, or AdminACL
+     * @notice Function to restrict access to only the artist of a project, or AdminACL
      * allowed calls, where AdminACL is the admin of a core contract at
-     * `_coreContract`.
-     * @param _projectId id of the project
-     * @param _coreContract address of the core contract to be checked
-     * @param _sender address of the caller
-     * @param _contract address of the contract being called
-     * @param _selector selector of the function being called
+     * `coreContract`.
+     * @param projectId id of the project
+     * @param coreContract address of the core contract to be checked
+     * @param sender address of the caller
+     * @param contract_ address of the contract being called
+     * @param selector selector of the function being called
      */
     function onlyCoreAdminACLOrArtist(
-        uint256 _projectId,
-        address _coreContract,
-        address _sender,
-        address _contract,
-        bytes4 _selector
+        uint256 projectId,
+        address coreContract,
+        address sender,
+        address contract_,
+        bytes4 selector
     ) internal {
         require(
             _senderIsArtist({
-                _projectId: _projectId,
-                _coreContract: _coreContract,
-                _sender: _sender
+                projectId: projectId,
+                coreContract: coreContract,
+                sender: sender
             }) ||
                 _coreAdminACLAllowed({
-                    _coreContract: _coreContract,
-                    _sender: _sender,
-                    _contract: _contract,
-                    _selector: _selector
+                    coreContract: coreContract,
+                    sender: sender,
+                    contract_: contract_,
+                    selector: selector
                 }),
             "Only Artist or Core Admin ACL"
         );
@@ -131,67 +130,67 @@ library AuthLib {
     // ------------------------------------------------------------------------
 
     /**
-     * Private function that returns if minter filter contract's AdminACL
-     * allows `_sender` to call function with selector `_selector` on contract
-     * `_contract`.
-     * @param _minterFilterAddress address of the minter filter to be checked.
+     * @notice Private function that returns if minter filter contract's AdminACL
+     * allows `sender` to call function with selector `selector` on contract
+     * `contract`.
+     * @param minterFilterAddress address of the minter filter to be checked.
      * Should implement IMinterFilterV1.
-     * @param _sender address of the caller
-     * @param _contract address of the contract being called
-     * @param _selector selector of the function being called
+     * @param sender address of the caller
+     * @param contract_ address of the contract being called
+     * @param selector selector of the function being called
      */
     function _minterFilterAdminACLAllowed(
-        address _minterFilterAddress,
-        address _sender,
-        address _contract,
-        bytes4 _selector
+        address minterFilterAddress,
+        address sender,
+        address contract_,
+        bytes4 selector
     ) private returns (bool) {
         return
-            IMinterFilterV1(_minterFilterAddress).adminACLAllowed({
-                _sender: _sender,
-                _contract: _contract,
-                _selector: _selector
+            IMinterFilterV1(minterFilterAddress).adminACLAllowed({
+                sender: sender,
+                contract_: contract_,
+                selector: selector
             });
     }
 
     /**
-     * Private function that returns if core contract's AdminACL allows
-     * `_sender` to call function with selector `_selector` on contract
-     * `_contract`.
-     * @param _coreContract address of the core contract to be checked
-     * @param _sender address of the caller
-     * @param _contract address of the contract being called
-     * @param _selector selector of the function being called
+     * @notice Private function that returns if core contract's AdminACL allows
+     * `sender` to call function with selector `selector` on contract
+     * `contract`.
+     * @param coreContract address of the core contract to be checked
+     * @param sender address of the caller
+     * @param contract_ address of the contract being called
+     * @param selector selector of the function being called
      */
     function _coreAdminACLAllowed(
-        address _coreContract,
-        address _sender,
-        address _contract,
-        bytes4 _selector
+        address coreContract,
+        address sender,
+        address contract_,
+        bytes4 selector
     ) private returns (bool) {
         return
-            IGenArt721CoreContractV3_Base(_coreContract).adminACLAllowed({
-                _sender: _sender,
-                _contract: _contract,
-                _selector: _selector
+            IGenArt721CoreContractV3_Base(coreContract).adminACLAllowed({
+                _sender: sender,
+                _contract: contract_,
+                _selector: selector
             });
     }
 
     /**
-     * Private function that returns if `_sender` is the artist of `_projectId`
-     * on `_coreContract`.
-     * @param _projectId project ID to check
-     * @param _coreContract core contract to check
-     * @param _sender wallet to check
+     * @notice Private function that returns if `sender` is the artist of `projectId`
+     * on `coreContract`.
+     * @param projectId project ID to check
+     * @param coreContract core contract to check
+     * @param sender wallet to check
      */
     function _senderIsArtist(
-        uint256 _projectId,
-        address _coreContract,
-        address _sender
+        uint256 projectId,
+        address coreContract,
+        address sender
     ) private view returns (bool senderIsArtist) {
         return
-            _sender ==
-            IGenArt721CoreContractV3_Base(_coreContract)
-                .projectIdToArtistAddress(_projectId);
+            sender ==
+            IGenArt721CoreContractV3_Base(coreContract)
+                .projectIdToArtistAddress(projectId);
     }
 }