@artblocks/contracts 1.0.3 → 1.0.4

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

@@ -0,0 +1,197 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
+import "../../interfaces/v0.8.x/IMinterFilterV1.sol";
+
+/**
+ * @title Art Blocks Authorization Minter Library
+ * @notice This library contains helper functions that may be used contracts to
+ * check authorization for performing operations in the Art Blocks V3 core
+ * contract ecosystem.
+ * @author Art Blocks Inc.
+ */
+
+library AuthLib {
+    /**
+     * 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,
+     * 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
+     */
+    function onlyMinterFilterAdminACL(
+        address _minterFilterAddress,
+        address _sender,
+        address _contract,
+        bytes4 _selector
+    ) internal {
+        require(
+            _minterFilterAdminACLAllowed({
+                _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`.
+     * 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
+     */
+    function onlyCoreAdminACL(
+        address _coreContract,
+        address _sender,
+        address _contract,
+        bytes4 _selector
+    ) internal {
+        require(
+            _coreAdminACLAllowed({
+                _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
+     * contract.
+     * @param _sender Wallet to check. Typically, the address of the caller.
+     */
+    function onlyArtist(
+        uint256 _projectId,
+        address _coreContract,
+        address _sender
+    ) internal view {
+        require(
+            _senderIsArtist({
+                _projectId: _projectId,
+                _coreContract: _coreContract,
+                _sender: _sender
+            }),
+            "Only Artist"
+        );
+    }
+
+    /**
+     * 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
+     */
+    function onlyCoreAdminACLOrArtist(
+        uint256 _projectId,
+        address _coreContract,
+        address _sender,
+        address _contract,
+        bytes4 _selector
+    ) internal {
+        require(
+            _senderIsArtist({
+                _projectId: _projectId,
+                _coreContract: _coreContract,
+                _sender: _sender
+            }) ||
+                _coreAdminACLAllowed({
+                    _coreContract: _coreContract,
+                    _sender: _sender,
+                    _contract: _contract,
+                    _selector: _selector
+                }),
+            "Only Artist or Core Admin ACL"
+        );
+    }
+
+    // ------------------------------------------------------------------------
+    // Private functions used internally by this library
+    // ------------------------------------------------------------------------
+
+    /**
+     * 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
+     */
+    function _minterFilterAdminACLAllowed(
+        address _minterFilterAddress,
+        address _sender,
+        address _contract,
+        bytes4 _selector
+    ) private returns (bool) {
+        return
+            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
+     */
+    function _coreAdminACLAllowed(
+        address _coreContract,
+        address _sender,
+        address _contract,
+        bytes4 _selector
+    ) private returns (bool) {
+        return
+            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
+     */
+    function _senderIsArtist(
+        uint256 _projectId,
+        address _coreContract,
+        address _sender
+    ) private view returns (bool senderIsArtist) {
+        return
+            _sender ==
+            IGenArt721CoreContractV3_Base(_coreContract)
+                .projectIdToArtistAddress(_projectId);
+    }
+}

package/contracts/libs/v0.8.x/minter-libs/DAExpLib.sol

@@ -0,0 +1,125 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Art Blocks Dutch Auction (exponential price curve) Library
+ * @notice This library is designed to implement logic and checks for Art
+ * Blocks projects using an exponential Dutch auctionprice curve for minting
+ * tokens.
+ * @author Art Blocks Inc.
+ */
+
+library DAExpLib {
+    struct DAProjectConfig {
+        // @dev max uint40 ~= 1.1e12 sec ~= 34 thousand years
+        uint40 timestampStart;
+        uint40 priceDecayHalfLifeSeconds;
+        // @dev max uint88 ~= 3e26 Wei = ~300 million ETH, which is well above
+        // the expected prices of any NFT mint in the foreseeable future.
+        uint88 startPrice;
+        uint88 basePrice;
+    }
+
+    /**
+     * @notice Sets auction details for an exponential-price auction type.
+     * @dev The function sets the auction start timestamp, price decay
+     * half-life, starting, and base prices for an exponential-price auction.
+     * @dev Minter implementations should ensure that any additional guard-
+     * rails are properly checked outside of this function. For example, the
+     * minter should check that _priceDecayHalfLifeSeconds is greater than the
+     * minter's minimum allowable value for price decay half-life (if the
+     * minter chooses to include that guard-rail).
+     * @param _DAProjectConfig The storage reference to the DAProjectConfig
+     * struct.
+     * @param _auctionTimestampStart The timestamp when the auction will start.
+     * @param _priceDecayHalfLifeSeconds The half-life time for price decay in
+     * seconds.
+     * @param _startPrice The starting price of the auction.
+     * @param _basePrice The base price of the auction.
+     * @param _allowReconfigureAfterStart Bool indicating whether the auction
+     * can be reconfigured after it has started. This is sometimes useful for
+     * minter implementations that want to allow an artist to reconfigure the
+     * auction after it has reached minter-local max invocations, for example.
+     */
+    function setAuctionDetailsExp(
+        DAProjectConfig storage _DAProjectConfig,
+        uint40 _auctionTimestampStart,
+        uint40 _priceDecayHalfLifeSeconds,
+        uint88 _startPrice,
+        uint88 _basePrice,
+        bool _allowReconfigureAfterStart
+    ) internal {
+        require(
+            _DAProjectConfig.timestampStart == 0 || // uninitialized
+                block.timestamp < _DAProjectConfig.timestampStart || // auction not yet started
+                _allowReconfigureAfterStart, // specifically allowing reconfiguration after start
+            "No modifications mid-auction"
+        );
+        require(
+            block.timestamp < _auctionTimestampStart,
+            "Only future auctions"
+        );
+        require(
+            _startPrice > _basePrice,
+            "Auction start price must be greater than auction end price"
+        );
+
+        // EFFECTS
+        _DAProjectConfig.timestampStart = _auctionTimestampStart;
+        _DAProjectConfig.priceDecayHalfLifeSeconds = _priceDecayHalfLifeSeconds;
+        _DAProjectConfig.startPrice = _startPrice;
+        _DAProjectConfig.basePrice = _basePrice;
+    }
+
+    /**
+     * @notice Gets price of minting a token given the project's
+     * DAProjectConfig.
+     * This function reverts if auction has not yet started, or if auction is
+     * unconfigured, which is relied upon by certain minter implications for
+     * security.
+     * @return uint256 current price of token in Wei
+     */
+    function getPriceExp(
+        DAProjectConfig storage _DAProjectConfig
+    ) internal view returns (uint256) {
+        // move parameters to memory if used more than once
+        uint256 _timestampStart = _DAProjectConfig.timestampStart;
+        uint256 _priceDecayHalfLifeSeconds = _DAProjectConfig
+            .priceDecayHalfLifeSeconds;
+        uint256 _basePrice = _DAProjectConfig.basePrice;
+
+        require(block.timestamp > _timestampStart, "Auction not yet started");
+        require(_priceDecayHalfLifeSeconds > 0, "Only configured auctions");
+        uint256 decayedPrice = _DAProjectConfig.startPrice;
+        uint256 elapsedTimeSeconds;
+        unchecked {
+            // already checked that block.timestamp > _timestampStart above
+            elapsedTimeSeconds = block.timestamp - _timestampStart;
+        }
+        // Divide by two (via bit-shifting) for the number of entirely completed
+        // half-lives that have elapsed since auction start time.
+        unchecked {
+            // already required _priceDecayHalfLifeSeconds > 0
+            decayedPrice >>= elapsedTimeSeconds / _priceDecayHalfLifeSeconds;
+        }
+        // Perform a linear interpolation between partial half-life points, to
+        // approximate the current place on a perfect exponential decay curve.
+        unchecked {
+            // value of expression is provably always less than decayedPrice,
+            // so no underflow is possible when the subtraction assignment
+            // operator is used on decayedPrice.
+            decayedPrice -=
+                (decayedPrice *
+                    (elapsedTimeSeconds % _priceDecayHalfLifeSeconds)) /
+                _priceDecayHalfLifeSeconds /
+                2;
+        }
+        if (decayedPrice < _basePrice) {
+            // Price may not decay below stay `basePrice`.
+            return _basePrice;
+        }
+        return decayedPrice;
+    }
+}

package/contracts/libs/v0.8.x/minter-libs/DALinLib.sol

@@ -0,0 +1,109 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title Art Blocks Dutch Auction (linear price curve) Library
+ * @notice This library is designed to implement logic and checks for Art
+ * Blocks projects using an exponential Dutch auctionprice curve for minting
+ * tokens.
+ * @author Art Blocks Inc.
+ */
+
+library DALinLib {
+    struct DAProjectConfig {
+        // @dev max uint40 ~= 1.1e12 sec ~= 34 thousand years
+        uint40 timestampStart;
+        uint40 timestampEnd;
+        // @dev max uint88 ~= 3e26 Wei = ~300 million ETH, which is well above
+        // the expected prices of any NFT mint in the foreseeable future.
+        uint88 startPrice;
+        uint88 basePrice;
+    }
+
+    /**
+     * @notice Sets auction details for a linear-price auction type.
+     * @dev The function sets the auction start timestamp, auction end
+     * timestamp, starting, and base prices for a linear-price auction.
+     * @dev Minter implementations should ensure that any additional guard-
+     * rails are properly checked outside of this function. For example, the
+     * minter should check that auction length is greater than the minter's
+     * minimum allowable value (if the minter chooses to include that guard-
+     * rail).
+     * @param _DAProjectConfig The storage reference to the DAProjectConfig
+     * struct.
+     * @param _auctionTimestampStart The timestamp when the auction will start.
+     * @param _auctionTimestampEnd The timestamp when the auction will end.
+     * @param _startPrice The starting price of the auction.
+     * @param _basePrice The base price of the auction.
+     * @param _allowReconfigureAfterStart Bool indicating whether the auction
+     * can be reconfigured after it has started. This is sometimes useful for
+     * minter implementations that want to allow an artist to reconfigure the
+     * auction after it has reached minter-local max invocations, for example.
+     */
+    function setAuctionDetailsLin(
+        DAProjectConfig storage _DAProjectConfig,
+        uint40 _auctionTimestampStart,
+        uint40 _auctionTimestampEnd,
+        uint88 _startPrice,
+        uint88 _basePrice,
+        bool _allowReconfigureAfterStart
+    ) internal {
+        require(
+            _DAProjectConfig.timestampStart == 0 || // uninitialized
+                block.timestamp < _DAProjectConfig.timestampStart || // auction not yet started
+                _allowReconfigureAfterStart, // specifically allowing reconfiguration after start
+            "No modifications mid-auction"
+        );
+        require(
+            block.timestamp < _auctionTimestampStart,
+            "Only future auctions"
+        );
+        require(
+            _startPrice > _basePrice,
+            "Auction start price must be greater than auction end price"
+        );
+
+        // EFFECTS
+        _DAProjectConfig.timestampStart = _auctionTimestampStart;
+        _DAProjectConfig.timestampEnd = _auctionTimestampEnd;
+        _DAProjectConfig.startPrice = _startPrice;
+        _DAProjectConfig.basePrice = _basePrice;
+    }
+
+    /**
+     * @notice Gets price of minting a token given the project's
+     * DAProjectConfig.
+     * This function reverts if auction has not yet started, or if auction is
+     * unconfigured.
+     * @return current price of token in Wei
+     */
+    function getPriceLin(
+        DAProjectConfig storage _DAProjectConfig
+    ) internal view returns (uint256) {
+        // move parameters to memory if used more than once
+        uint256 _timestampStart = _DAProjectConfig.timestampStart;
+        uint256 _timestampEnd = _DAProjectConfig.timestampEnd;
+        uint256 _startPrice = _DAProjectConfig.startPrice;
+        uint256 _basePrice = _DAProjectConfig.basePrice;
+
+        require(block.timestamp > _timestampStart, "Auction not yet started");
+        if (block.timestamp >= _timestampEnd) {
+            require(_timestampEnd > 0, "Only configured auctions");
+            return _basePrice;
+        }
+        uint256 elapsedTime;
+        uint256 duration;
+        uint256 startToEndDiff;
+        unchecked {
+            // already checked that block.timestamp > _timestampStart
+            elapsedTime = block.timestamp - _timestampStart;
+            // _timestampEnd > _timestampStart enforced during assignment
+            duration = _timestampEnd - _timestampStart;
+            // _startPrice > _basePrice enforced during assignment
+            startToEndDiff = _startPrice - _basePrice;
+        }
+        return _startPrice - ((elapsedTime * startToEndDiff) / duration);
+    }
+}