@artblocks/contracts 0.0.1

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

@@ -0,0 +1,70 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV1.sol";
+import "./IFilteredMinterDAExpV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterV1 interface in order to
+ * add support for Dutch Auction with Settlement minter updates.
+ * @dev keys represent strings of finite length encoded in bytes32 to minimize
+ * gas.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterDAExpSettlementV0 is
+    IFilteredMinterV1,
+    IFilteredMinterDAExpV0
+{
+    /// Auction details cleared for project `projectId`.
+    /// At time of reset, the project has had `numPurchases` purchases on this
+    /// minter, with a most recent purchase price of `latestPurchasePrice`. If
+    /// the number of purchases is 0, the latest purchase price will have a
+    /// dummy value of 0.
+    event ResetAuctionDetails(
+        uint256 indexed projectId,
+        uint256 numPurchases,
+        uint256 latestPurchasePrice
+    );
+
+    /// sellout price updated for project `projectId`.
+    /// @dev does not use generic event because likely will trigger additional
+    /// actions in indexing layer
+    event SelloutPriceUpdated(
+        uint256 indexed _projectId,
+        uint256 _selloutPrice
+    );
+
+    /// artist and admin have withdrawn revenues from settleable purchases for
+    /// project `projectId`.
+    /// @dev does not use generic event because likely will trigger additional
+    /// actions in indexing layer
+    event ArtistAndAdminRevenuesWithdrawn(uint256 indexed _projectId);
+
+    /// receipt has an updated state
+    event ReceiptUpdated(
+        address indexed _purchaser,
+        uint256 indexed _projectId,
+        uint256 _numPurchased,
+        uint256 _netPosted
+    );
+
+    /// returns latest purchase price for project `_projectId`, or 0 if no
+    /// purchases have been made.
+    function getProjectLatestPurchasePrice(
+        uint256 _projectId
+    ) external view returns (uint256 latestPurchasePrice);
+
+    /// returns the number of settleable invocations for project `_projectId`.
+    function getNumSettleableInvocations(
+        uint256 _projectId
+    ) external view returns (uint256 numSettleableInvocations);
+
+    /// Returns the current excess settlement funds on project `_projectId`
+    /// for address `_walletAddress`.
+    function getProjectExcessSettlementFunds(
+        uint256 _projectId,
+        address _walletAddress
+    ) external view returns (uint256 excessSettlementFundsInWei);
+}

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

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterV0 interface in order to
+ * add support for exponential descending auctions.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterDAExpV0 is IFilteredMinterV0 {
+    /// Auction details updated for project `projectId`.
+    event SetAuctionDetails(
+        uint256 indexed projectId,
+        uint256 _auctionTimestampStart,
+        uint256 _priceDecayHalfLifeSeconds,
+        uint256 _startPrice,
+        uint256 _basePrice
+    );
+
+    /// Auction details cleared for project `projectId`.
+    event ResetAuctionDetails(uint256 indexed projectId);
+
+    /// Maximum and minimum allowed price decay half lifes updated.
+    event AuctionHalfLifeRangeSecondsUpdated(
+        uint256 _minimumPriceDecayHalfLifeSeconds,
+        uint256 _maximumPriceDecayHalfLifeSeconds
+    );
+
+    function minimumPriceDecayHalfLifeSeconds() external view returns (uint256);
+
+    function maximumPriceDecayHalfLifeSeconds() external view returns (uint256);
+}

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

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterDAExpV0.sol";
+import "./IFilteredMinterV2.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterDAExpV0 interface in order to
+ * add support for manually setting project max invocations.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterDAExpV1 is IFilteredMinterDAExpV0, IFilteredMinterV2 {
+
+}

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

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterV0 interface in order to
+ * add support for linear descending auctions.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterDALinV0 is IFilteredMinterV0 {
+    /// Auction details updated for project `projectId`.
+    event SetAuctionDetails(
+        uint256 indexed projectId,
+        uint256 _auctionTimestampStart,
+        uint256 _auctionTimestampEnd,
+        uint256 _startPrice,
+        uint256 _basePrice
+    );
+
+    /// Auction details cleared for project `projectId`.
+    event ResetAuctionDetails(uint256 indexed projectId);
+
+    /// Minimum allowed auction length updated
+    event MinimumAuctionLengthSecondsUpdated(
+        uint256 _minimumAuctionLengthSeconds
+    );
+
+    function minimumAuctionLengthSeconds() external view returns (uint256);
+}

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

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterDALinV0.sol";
+import "./IFilteredMinterV2.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterDALinV0 interface in order to
+ * add support for manually setting project max invocations.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterDALinV1 is IFilteredMinterDALinV0, IFilteredMinterV2 {
+
+}

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

@@ -0,0 +1,68 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterV0 interface in order to
+ * add support for including owned NFT token address and token ID information.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterHolderV0 is IFilteredMinterV0 {
+    /**
+     * @notice Registered holders of NFTs at address `_NFTAddress` to be
+     * considered for minting.
+     */
+    event RegisteredNFTAddress(address indexed _NFTAddress);
+
+    /**
+     * @notice Unregistered holders of NFTs at address `_NFTAddress` to be
+     * considered for minting.
+     */
+    event UnregisteredNFTAddress(address indexed _NFTAddress);
+
+    /**
+     * @notice Allow holders of NFTs at addresses `_ownedNFTAddresses`, project
+     * IDs `_ownedNFTProjectIds` to mint on project `_projectId`.
+     * `_ownedNFTAddresses` assumed to be aligned with `_ownedNFTProjectIds`.
+     * e.g. Allows holders of project `_ownedNFTProjectIds[0]` on token
+     * contract `_ownedNFTAddresses[0]` to mint.
+     */
+    event AllowedHoldersOfProjects(
+        uint256 indexed _projectId,
+        address[] _ownedNFTAddresses,
+        uint256[] _ownedNFTProjectIds
+    );
+
+    /**
+     * @notice Remove holders of NFTs at addresses `_ownedNFTAddresses`,
+     * project IDs `_ownedNFTProjectIds` to mint on project `_projectId`.
+     * `_ownedNFTAddresses` assumed to be aligned with `_ownedNFTProjectIds`.
+     * e.g. Removes holders of project `_ownedNFTProjectIds[0]` on token
+     * contract `_ownedNFTAddresses[0]` from mint allowlist.
+     */
+    event RemovedHoldersOfProjects(
+        uint256 indexed _projectId,
+        address[] _ownedNFTAddresses,
+        uint256[] _ownedNFTProjectIds
+    );
+
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address, using owned ERC-721 NFT to claim right to purchase.
+    function purchase(
+        uint256 _projectId,
+        address _ownedNftAddress,
+        uint256 _ownedNftTokenId
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, to the specified
+    // receiving address, using owned ERC-721 NFT to claim right to purchase.
+    function purchaseTo(
+        address _to,
+        uint256 _projectId,
+        address _ownedNftAddress,
+        uint256 _ownedNftTokenId
+    ) external payable returns (uint256 tokenId);
+}

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

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterHolderV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterHolderV0 interface in order
+ * to add support for configuring and indexing the delegation registry address.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterHolderV1 is IFilteredMinterHolderV0 {
+    /**
+     * @notice Notifies of the contract's configured delegation registry
+     * address.
+     */
+    event DelegationRegistryUpdated(address delegationRegistryAddress);
+}

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

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterHolderV1.sol";
+import "./IFilteredMinterV2.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterHolderV1 interface in order to
+ * add support for manually setting project max invocations.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterHolderV2 is
+    IFilteredMinterHolderV1,
+    IFilteredMinterV2
+{
+
+}

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

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV1.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterV1 interface in order to
+ * add support for including Merkle proofs when purchasing.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterMerkleV0 is IFilteredMinterV1 {
+    /**
+     * @notice Notifies of the contract's default maximum mints allowed per
+     * user for a given project, on this minter. This value can be overridden
+     * by the artist of any project at any time.
+     */
+    event DefaultMaxInvocationsPerAddress(
+        uint256 defaultMaxInvocationsPerAddress
+    );
+
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address. Requires Merkle proof.
+    function purchase(
+        uint256 _projectId,
+        bytes32[] memory _proof
+    ) external payable returns (uint256 tokenId);
+
+    // Triggers a purchase of a token from the desired project, to the specified
+    // receiving address. Requires Merkle proof.
+    function purchaseTo(
+        address _to,
+        uint256 _projectId,
+        bytes32[] memory _proof
+    ) external payable returns (uint256 tokenId);
+}

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

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterMerkleV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterMerkleV0 interface in order
+ * to add support for configuring and indexing the delegation registry address.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterMerkleV1 is IFilteredMinterMerkleV0 {
+    /**
+     * @notice Notifies of the contract's configured delegation registry
+     * address.
+     */
+    event DelegationRegistryUpdated(address delegationRegistryAddress);
+}

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

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterMerkleV1.sol";
+import "./IFilteredMinterV2.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterMerkleV0 interface in order to
+ * add support for manually setting project max invocations.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterMerkleV2 is
+    IFilteredMinterMerkleV1,
+    IFilteredMinterV2
+{
+
+}

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

@@ -0,0 +1,74 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IFilteredMinterV0 {
+    /**
+     * @notice Price per token in wei updated for project `_projectId` to
+     * `_pricePerTokenInWei`.
+     */
+    event PricePerTokenInWeiUpdated(
+        uint256 indexed _projectId,
+        uint256 indexed _pricePerTokenInWei
+    );
+
+    /**
+     * @notice Currency updated for project `_projectId` to symbol
+     * `_currencySymbol` and address `_currencyAddress`.
+     */
+    event ProjectCurrencyInfoUpdated(
+        uint256 indexed _projectId,
+        address indexed _currencyAddress,
+        string _currencySymbol
+    );
+
+    /// togglePurchaseToDisabled updated
+    event PurchaseToDisabledUpdated(
+        uint256 indexed _projectId,
+        bool _purchaseToDisabled
+    );
+
+    // getter function of public variable
+    function minterType() external view returns (string memory);
+
+    function genArt721CoreAddress() external returns (address);
+
+    function minterFilterAddress() external returns (address);
+
+    // Triggers a purchase of a token from the desired project, to the
+    // TX-sending address.
+    function purchase(
+        uint256 _projectId
+    ) 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
+    ) external payable returns (uint256 tokenId);
+
+    // Toggles the ability for `purchaseTo` to be called directly with a
+    // specified receiving address that differs from the TX-sending address.
+    function togglePurchaseToDisabled(uint256 _projectId) external;
+
+    // Called to make the minter contract aware of the max invocations for a
+    // given project.
+    function setProjectMaxInvocations(uint256 _projectId) external;
+
+    // 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
+    )
+        external
+        view
+        returns (
+            bool isConfigured,
+            uint256 tokenPriceInWei,
+            string memory currencySymbol,
+            address currencyAddress
+        );
+}

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

@@ -0,0 +1,127 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV0.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterV0 interface in order to
+ * add support for generic project minter configuration updates.
+ * @dev keys represent strings of finite length encoded in bytes32 to minimize
+ * gas.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterV1 is IFilteredMinterV0 {
+    /// ANY
+    /**
+     * @notice Generic project minter configuration event. Removes key `_key`
+     * for project `_projectId`.
+     */
+    event ConfigKeyRemoved(uint256 indexed _projectId, bytes32 _key);
+
+    /// BOOL
+    /**
+     * @notice Generic project minter configuration event. Sets value of key
+     * `_key` to `_value` for project `_projectId`.
+     */
+    event ConfigValueSet(uint256 indexed _projectId, 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,
+        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,
+        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,
+        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,
+        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,
+        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,
+        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,
+        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,
+        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,
+        bytes32 _key,
+        bytes32 _value
+    );
+
+    /**
+     * @dev Strings not supported. Recommend conversion of (short) strings to
+     * bytes32 to remain gas-efficient.
+     */
+}

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

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+import "./IFilteredMinterV1.sol";
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title This interface extends the IFilteredMinterV1 interface in order to
+ * add support for manually setting project max invocations.
+ * @author Art Blocks Inc.
+ */
+interface IFilteredMinterV2 is IFilteredMinterV1 {
+    /**
+     * @notice Local max invocations for project `_projectId`, tied to core contract `_coreContractAddress`,
+     * updated to `_maxInvocations`.
+     */
+    event ProjectMaxInvocationsLimitUpdated(
+        uint256 indexed _projectId,
+        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,
+        uint256 _maxInvocations
+    ) external;
+}

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

@@ -0,0 +1,73 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IGenArt721CoreContractV1 {
+    // getter function of public variable
+    function admin() external view returns (address);
+
+    // getter function of public variable
+    function nextProjectId() external view returns (uint256);
+
+    // getter function of public mapping
+    function tokenIdToProjectId(
+        uint256 tokenId
+    ) external view returns (uint256 projectId);
+
+    function isWhitelisted(address sender) external view returns (bool);
+
+    // @dev this is not available in V0
+    function isMintWhitelisted(address minter) external view returns (bool);
+
+    function projectIdToArtistAddress(
+        uint256 _projectId
+    ) external view returns (address payable);
+
+    function projectIdToAdditionalPayee(
+        uint256 _projectId
+    ) external view returns (address payable);
+
+    function projectIdToAdditionalPayeePercentage(
+        uint256 _projectId
+    ) external view returns (uint256);
+
+    function projectTokenInfo(
+        uint256 _projectId
+    )
+        external
+        view
+        returns (
+            address,
+            uint256,
+            uint256,
+            uint256,
+            bool,
+            address,
+            uint256,
+            string memory,
+            address
+        );
+
+    function artblocksAddress() external view returns (address payable);
+
+    function artblocksPercentage() external view returns (uint256);
+
+    function mint(
+        address _to,
+        uint256 _projectId,
+        address _by
+    ) external returns (uint256 tokenId);
+
+    function getRoyaltyData(
+        uint256 _tokenId
+    )
+        external
+        view
+        returns (
+            address artistAddress,
+            address additionalPayee,
+            uint256 additionalPayeePercentage,
+            uint256 royaltyFeeByID
+        );
+}