@artblocks/contracts 1.0.3 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artblocks/contracts",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Smart contracts used by Art Blocks",
   "files": [
     "/contracts/**/*.sol",
@@ -11,7 +11,7 @@
     "compile": "hardhat compile",
     "build": "hardhat --config build-package.config.ts compile",
     "docgen": "hardhat docgen",
-    "generate:typechain": "typechain --target ethers-v5 --outDir ./scripts/contracts './artifacts/contracts/**/!(*.dbg)*.json'",
+    "generate:typechain": "typechain --target ethers-v5 --out-dir ./scripts/contracts './artifacts/contracts/**/!(*.dbg)*.json'",
     "test": "hardhat test",
     "size": "hardhat size-contracts",
     "test:parallel": "hardhat test --parallel",
@@ -20,66 +20,87 @@
     "lint": "prettier --check 'contracts/**/*.sol' && prettier --check 'scripts/**/*.ts' && prettier --check 'test/**/*.ts' && npx eslint 'test/**/*.ts'",
     "remix": "remixd -s ./ --remix-ide https://remix.ethereum.org",
     "codegen": "yarn --cwd=\"../..\" codegen:project contracts",
-    "deploy:dev:v3-engine": "yarn codegen && NODE_ENV=dev yarn hardhat run --network goerli scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:dev-arbitrum:v3-engine": "yarn codegen && NODE_ENV=arbitrum-dev yarn hardhat run --network arbitrum-goerli scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:staging-arbitrum:v3-engine": "yarn codegen && NODE_ENV=arbitrum-staging yarn hardhat run --network arbitrum-goerli scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:staging:v3-engine": "yarn codegen && NODE_ENV=staging yarn hardhat run --network goerli scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:mainnet:v3-engine": "yarn codegen && NODE_ENV=mainnet yarn hardhat run --network mainnet scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:goerli:minter": "yarn hardhat run --network goerli scripts/minter-deployments/V3/generic-minter-deployer-v3core.ts",
-    "deploy:mainnet:minter": "yarn hardhat run --network mainnet scripts/minter-deployments/V3/generic-minter-deployer-v3core.ts",
-    "pre-commit": "yarn lint"
+    "deploy:v3-engine:dev": "yarn codegen && yarn require-low-gas goerli && NODE_ENV=dev yarn hardhat run --network goerli scripts/engine/V3/generic-engine-shared-suite-deployer.ts",
+    "deploy:v3-engine:dev-arbitrum": "yarn codegen && yarn require-low-gas arbitrum-goerli && NODE_ENV=arbitrum-dev yarn hardhat run --network arbitrum-goerli scripts/engine/V3/generic-engine-shared-suite-deployer.ts",
+    "deploy:v3-engine:staging-arbitrum:": "yarn codegen && yarn require-low-gas arbitrum-goerli && NODE_ENV=arbitrum-staging yarn hardhat run --network arbitrum-goerli scripts/engine/V3/generic-engine-shared-suite-deployer.ts",
+    "deploy:v3-engine:arbitrum": "yarn codegen && yarn require-low-gas arbitrum && NODE_ENV=arbitrum yarn hardhat run --network arbitrum scripts/engine/V3/generic-engine-shared-suite-deployer.ts",
+    "deploy:v3-engine:staging": "yarn codegen && yarn require-low-gas goerli && NODE_ENV=staging yarn hardhat run --network goerli scripts/engine/V3/generic-engine-shared-suite-deployer.ts",
+    "deploy:v3-engine:mainnet": "yarn codegen && yarn require-low-gas mainnet && NODE_ENV=mainnet yarn hardhat run --network mainnet scripts/engine/V3/generic-engine-shared-suite-deployer.ts",
+    "deploy:shared-randomizer:goerli": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-randomizer:mainnet": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-randomizer:arbitrum-goerli": "yarn require-low-gas arbitrum-goerli && yarn hardhat run --network arbitrum-goerli scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-randomizer:arbitrum": "yarn require-low-gas arbitrum && yarn hardhat run --network arbitrum scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-minter-filter:goerli": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-minter-filter:mainnet": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-minter-filter:arbitrum-goerli": "yarn require-low-gas arbitrum-goerli && yarn hardhat run --network arbitrum-goerli scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-minter-filter:arbitrum": "yarn require-low-gas arbitrum && yarn hardhat run --network arbitrum scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-minters:goerli": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/minter-deployments/shared-minters-deployer.ts",
+    "deploy:shared-minters:mainnet": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/minter-deployments/shared-minters-deployer.ts",
+    "deploy:shared-minters:arbitrum-goerli": "yarn require-low-gas arbitrum-goerli && yarn hardhat run --network arbitrum-goerli scripts/minter-deployments/shared-minters-deployer.ts",
+    "deploy:shared-minters:arbitrum": "yarn require-low-gas arbitrum && yarn hardhat run --network arbitrum scripts/minter-deployments/shared-minters-deployer.ts",
+    "require-low-gas": "yarn hardhat run scripts/require-low-gas.ts --network",
+    "pre-commit": "yarn lint",
+    "deploy:deprecated:dev:v3-engine": "yarn codegen && yarn require-low-gas goerli && NODE_ENV=dev yarn hardhat run --network goerli scripts/engine/V3/deprecated/generic-engine-deployer.ts",
+    "deploy:deprecated:staging:v3-engine": "yarn codegen && yarn require-low-gas goerli && NODE_ENV=staging yarn hardhat run --network goerli scripts/engine/V3/deprecated/generic-engine-deployer.ts",
+    "deploy:deprecated:dev-arbitrum:v3-engine": "yarn codegen && yarn require-low-gas arbitrum-goerli && NODE_ENV=arbitrum-dev yarn hardhat run --network arbitrum-goerli scripts/engine/V3/deprecated/generic-engine-deployer.ts",
+    "deploy:deprecated:staging-arbitrum:v3-engine": "yarn codegen && yarn require-low-gas arbitrum-goerli && NODE_ENV=arbitrum-staging yarn hardhat run --network arbitrum-goerli scripts/engine/V3/deprecated/generic-engine-deployer.ts",
+    "deploy:deprecated:arbitrum:v3-engine": "yarn codegen && yarn require-low-gas arbitrum && NODE_ENV=arbitrum yarn hardhat run --network arbitrum scripts/engine/V3/deprecated/generic-engine-deployer.ts",
+    "deploy:deprecated:mainnet:v3-engine": "yarn codegen && yarn require-low-gas mainnet && NODE_ENV=mainnet yarn hardhat run --network mainnet scripts/engine/V3/deprecated/generic-engine-deployer.ts",
+    "deploy:deprecated:goerli:non-shared-minter": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/minter-deployments/V3/generic-minter-deployer-v3core.ts",
+    "deploy:deprecated:mainnet:non-shared-minter": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/minter-deployments/V3/generic-minter-deployer-v3core.ts"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.338.0",
-    "@aws-sdk/credential-providers": "^3.338.0",
-    "@defi-wonderland/smock": "^2.3.4",
+    "@aws-sdk/client-s3": "^3.433.0",
+    "@aws-sdk/credential-providers": "^3.433.0",
+    "@defi-wonderland/smock": "^2.3.5",
     "@gnosis.pm/safe-contracts": "^1.3.0",
     "@gnosis.pm/safe-core-sdk": "^2.1.0",
     "@gnosis.pm/safe-core-sdk-types": "^1.7.0",
     "@gnosis.pm/safe-ethers-lib": "1.1.0",
     "@gnosis.pm/safe-service-client": "^1.4.0",
-    "@nomicfoundation/hardhat-network-helpers": "^1.0.8",
+    "@nomicfoundation/hardhat-network-helpers": "^1.0.9",
     "@nomiclabs/hardhat-ethers": "^2.2.1",
     "@nomiclabs/hardhat-etherscan": "^3.1.4",
     "@nomiclabs/hardhat-solhint": "^3.0.0",
     "@nomiclabs/hardhat-truffle5": "^2.0.7",
     "@nomiclabs/hardhat-waffle": "^2.0.3",
     "@nomiclabs/hardhat-web3": "^2.0.0",
-    "@openzeppelin/hardhat-upgrades": "^1.26.0",
+    "@openzeppelin/hardhat-upgrades": "^1.28.0",
     "@openzeppelin/test-helpers": "^0.5.16",
-    "@remix-project/remixd": "^0.6.14",
-    "@typechain/ethers-v5": "^6.0.5",
-    "@types/jest": "^29.4.0",
-    "@types/mocha": "^10.0.1",
-    "@types/prompt": "^1.1.5",
-    "@typescript-eslint/eslint-plugin": "^5.59.7",
-    "@typescript-eslint/parser": "^5.59.7",
-    "aws-sdk-client-mock": "^2.1.1",
-    "chai": "^4.3.7",
+    "@remix-project/remixd": "^0.6.18",
+    "@typechain/ethers-v5": "^11.1.2",
+    "@types/jest": "^29.5.6",
+    "@types/mocha": "^10.0.3",
+    "@types/prompt": "^1.1.7",
+    "@typescript-eslint/eslint-plugin": "^6.9.0",
+    "@typescript-eslint/parser": "^6.9.0",
+    "aws-sdk-client-mock": "^3.0.0",
+    "chai": "^4.3.10",
     "coveralls": "^3.1.1",
-    "dotenv": "^16.0.3",
-    "eslint": "^8.41.0",
-    "eslint-plugin-mocha": "^10.1.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.52.0",
     "eslint-config-custom": "*",
+    "eslint-plugin-mocha": "^10.2.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "ethereum-waffle": "^4.0.10",
     "ethers": "^5.7.2",
-    "hardhat": "^2.12.5",
-    "hardhat-contract-sizer": "^2.9.0",
+    "hardhat": "^2.18.2",
+    "hardhat-contract-sizer": "^2.10.0",
     "hardhat-docgen": "^1.3.0",
     "hardhat-gas-reporter": "^1.0.9",
     "husky": "^8.0.3",
     "istanbul-combine": "^0.3.0",
     "keccak256": "^1.0.6",
     "merkletreejs": "^0.3.9",
-    "prettier": "^2.8.1",
+    "prettier": "^3.0.3",
     "prettier-plugin-solidity": "^1.1.1",
     "prompt": "^1.3.0",
     "prompt-sync": "^4.2.0",
-    "solidity-coverage": "^0.8.0",
+    "solidity-coverage": "^0.8.5",
     "ts-node": "^9.1.1",
     "tsconfig": "*",
-    "typechain": "^4.0.3",
-    "typescript": "^5.0.2"
+    "typechain": "^8.3.2",
+    "typescript": "^5.2.2"
   },
   "author": "Art Blocks, Inc",
   "license": "LGPL-3.0-only",
@@ -88,8 +109,8 @@
     "@openzeppelin-4.5/contracts": "npm:@openzeppelin/contracts@4.5.0",
     "@openzeppelin-4.7/contracts": "npm:@openzeppelin/contracts@4.7.1",
     "@openzeppelin-4.8/contracts-upgradeable": "npm:@openzeppelin/contracts-upgradeable@4.8.0",
-    "@urql/exchange-retry": "^1.0.0",
-    "graphql": "^16.6.0",
-    "urql": "^4.0.0"
+    "@urql/exchange-retry": "^1.2.0",
+    "graphql": "^16.8.1",
+    "urql": "^4.0.5"
   }
 }

package/LICENSE

@@ -1,165 +0,0 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.

package/contracts/interfaces/0.8.x/IRandomizer_V3CoreBase.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-// Creatd By: Art Blocks Inc.
-
-pragma solidity ^0.8.0;
-
-interface IRandomizer_V3CoreBase {
-    // When a core contract calls this, it can be assured that the randomizer
-    // will set a bytes32 hash for tokenId `_tokenId` on the core contract.
-    function assignTokenHash(uint256 _tokenId) external;
-}

package/contracts/interfaces/0.8.x/ISharedRandomizerV0.sol

@@ -1,105 +0,0 @@
-// SPDX-License-Identifier: LGPL-3.0-only
-// Creatd By: Art Blocks Inc.
-
-pragma solidity ^0.8.0;
-
-import "./IRandomizer_V3CoreBase.sol";
-
-interface ISharedRandomizerV0 is IRandomizer_V3CoreBase {
-    /**
-     * @notice The pseudorandom atomic contract that is used to generate
-     * pseudorandom values for this randomizer was updated.
-     */
-    event PseudorandomAtomicContractUpdated(
-        address indexed pseudorandomAtomicContract
-    );
-
-    /**
-     * @notice Minter contract at `_hashSeedSetterContract` allowed to assign
-     * token hash seeds on core contract `_coreContract`.
-     */
-    event HashSeedSetterForCoreUpdated(
-        address indexed coreContract,
-        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).
-     */
-    event ProjectIsPolyptychUpdated(
-        address coreContract,
-        uint256 projectId,
-        bool isPolyptych
-    );
-
-    /**
-     * @notice Allows the owner of a core contract 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 _hashSeedSetterContract - the contract that is allowed to assign
-     * hash seeds to tokens
-     */
-    function setHashSeedSetterContract(
-        address _coreContract,
-        address _hashSeedSetterContract
-    ) external;
-
-    /**
-     * @notice Allows the artist of a project to configure as as a polyptych
-     * project.
-     * @param _coreContract - The address of the core contract
-     * @param _projectId - The ID of the project that has a polyptych panel
-     * (second, third, etc.)
-     */
-    function toggleProjectIsPolyptych(
-        address _coreContract,
-        uint256 _projectId
-    ) external;
-
-    /**
-     * @notice Store the token hash seed for an existing token to be re-used in
-     * a polyptych panel.
-     * @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(
-        address _coreContract,
-        uint256 _tokenId,
-        bytes12 _hashSeed
-    ) external;
-
-    /**
-     * @notice Boolean representing whether or not project with ID `_projectId`
-     * on core contract `_coreContract` is currently enabled for polyptych
-     * minting.
-     */
-    function projectIsPolyptych(
-        address _coreContract,
-        uint256 _projectId
-    ) external view returns (bool _isPolyptych);
-
-    /**
-     * 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
-     */
-    function hashSeedSetterContracts(
-        address _coreContract
-    ) 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.
-     * @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(
-        address _coreContract,
-        uint256 _tokenId
-    ) external view returns (bytes12 _hashSeed);
-}