MarketplaceV3 updates and design doc (#334)

* thirdweb stamp on marketplace-v3 contracts

* ascii art

* slither action

* remove ascii, add author

* docs

* fix bid amounts

* v3.4.2-0

* design doc

* fix doc

* Update marketplace-v3.md

Author: kumaryash90

contracts/extension/plugin/ContractMetadataLogic.sol

@@ -1,10 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "./ContractMetadataStorage.sol";
 import "../../extension/interface/IContractMetadata.sol";
 
 /**
+ *  @author  thirdweb.com
+ *
  *  @title   Contract Metadata
  *  @notice  Thirdweb's `ContractMetadata` is a contract extension for any base contracts. It lets you set a metadata URI
  *           for you contract.

contracts/extension/plugin/ContractMetadataStorage.sol

@@ -1,6 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
+/**
+ *  @author  thirdweb.com
+ */
 library ContractMetadataStorage {
     bytes32 public constant CONTRACT_METADATA_STORAGE_POSITION = keccak256("contract.metadata.storage");
 

contracts/extension/plugin/PermissionsEnumerableLogic.sol

@@ -1,10 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "./PermissionsEnumerableStorage.sol";
 import "./PermissionsLogic.sol";
 
 /**
+ *  @author  thirdweb.com
+ *
  *  @title   PermissionsEnumerable
  *  @dev     This contracts provides extending-contracts with role-based access control mechanisms.
  *           Also provides interfaces to view all members with a given role, and total count of members.

contracts/extension/plugin/PermissionsEnumerableStorage.sol

@@ -1,8 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "../../extension/interface/IPermissionsEnumerable.sol";
 
+/**
+ *  @author  thirdweb.com
+ */
 library PermissionsEnumerableStorage {
     bytes32 public constant PERMISSIONS_ENUMERABLE_STORAGE_POSITION = keccak256("permissions.enumerable.storage");
 

contracts/extension/plugin/PermissionsLogic.sol

@@ -1,11 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "../../extension/interface/IPermissions.sol";
 import "./PermissionsStorage.sol";
 import "../../lib/TWStrings.sol";
 
 /**
+ *  @author  thirdweb.com
+ *
  *  @title   Permissions
  *  @dev     This contracts provides extending-contracts with role-based access control mechanisms
  */

contracts/extension/plugin/PermissionsStorage.sol

@@ -1,6 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
+/**
+ *  @author  thirdweb.com
+ */
 library PermissionsStorage {
     bytes32 public constant PERMISSIONS_STORAGE_POSITION = keccak256("permissions.storage");
 

contracts/extension/plugin/PlatformFeeLogic.sol

@@ -1,10 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "./PlatformFeeStorage.sol";
 import "../../extension/interface/IPlatformFee.sol";
 
 /**
+ *  @author  thirdweb.com
+ *
  *  @title   Platform Fee
  *  @notice  Thirdweb's `PlatformFee` is a contract extension to be used with any base contract. It exposes functions for setting and reading
  *           the recipient of platform fee and the platform fee basis points, and lets the inheriting contract perform conditional logic

contracts/extension/plugin/PlatformFeeStorage.sol

@@ -1,6 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
+/**
+ *  @author  thirdweb.com
+ */
 library PlatformFeeStorage {
     bytes32 public constant PLATFORM_FEE_STORAGE_POSITION = keccak256("platform.fee.storage");
 

contracts/extension/plugin/PluginMap.sol

@@ -1,9 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "../interface/plugin/IPluginMap.sol";
 import "../../openzeppelin-presets/utils/EnumerableSet.sol";
 
+/**
+ *  @author  thirdweb.com
+ */
 contract PluginMap is IPluginMap {
     using EnumerableSet for EnumerableSet.Bytes32Set;
 

contracts/extension/plugin/Router.sol

@@ -1,11 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "../interface/plugin/IRouter.sol";
 import "../../extension/Multicall.sol";
 import "../../eip/ERC165.sol";
 import "../../openzeppelin-presets/utils/EnumerableSet.sol";
 
+/**
+ *  @author  thirdweb.com
+ */
 library RouterStorage {
     bytes32 public constant ROUTER_STORAGE_POSITION = keccak256("router.storage");
 

contracts/extension/plugin/RouterImmutable.sol

@@ -1,8 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 import "./Router.sol";
 
+/**
+ *  @author  thirdweb.com
+ */
 contract RouterImmutable is Router {
     /*///////////////////////////////////////////////////////////////
                     Constructor + initializer logic

contracts/marketplace/IMarketplace.sol

@@ -1,7 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.11;
 
 /**
+ *  @author  thirdweb.com
+ *
  *  The `DirectListings` extension smart contract lets you buy and sell NFTs (ERC-721 or ERC-1155) for a fixed price.
  */
 interface IDirectListings {

contracts/marketplace/direct-listings/DirectListingsLogic.sol

@@ -1,4 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.11;
 
 import "./DirectListingsStorage.sol";
@@ -17,6 +19,9 @@ import "../../extension/plugin/ReentrancyGuardLogic.sol";
 import "../../extension/plugin/PermissionsEnumerableLogic.sol";
 import { CurrencyTransferLib } from "../../lib/CurrencyTransferLib.sol";
 
+/**
+ * @author  thirdweb.com
+ */
 contract DirectListingsLogic is IDirectListings, ReentrancyGuardLogic, ERC2771ContextConsumer {
     /*///////////////////////////////////////////////////////////////
                         Constants / Immutables

contracts/marketplace/direct-listings/DirectListingsStorage.sol

@@ -1,8 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.11;
 
 import { IDirectListings } from "../IMarketplace.sol";
 
+/**
+ * @author  thirdweb.com
+ */
 library DirectListingsStorage {
     bytes32 public constant DIRECT_LISTINGS_STORAGE_POSITION = keccak256("direct.listings.storage");
 

contracts/marketplace/english-auctions/EnglishAuctionsLogic.sol

@@ -1,4 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.11;
 
 import "./EnglishAuctionsStorage.sol";
@@ -21,6 +23,9 @@ import "../../extension/plugin/ReentrancyGuardLogic.sol";
 import "../../extension/plugin/PermissionsEnumerableLogic.sol";
 import { CurrencyTransferLib } from "../../lib/CurrencyTransferLib.sol";
 
+/**
+ * @author  thirdweb.com
+ */
 contract EnglishAuctionsLogic is IEnglishAuctions, ReentrancyGuardLogic, ERC2771ContextConsumer {
     /*///////////////////////////////////////////////////////////////
                         Constants / Immutables
@@ -129,6 +134,7 @@ contract EnglishAuctionsLogic is IEnglishAuctions, ReentrancyGuardLogic, ERC2771
             _targetAuction.endTimestamp > block.timestamp && _targetAuction.startTimestamp <= block.timestamp,
             "Marketplace: inactive auction."
         );
+        require(_bidAmount != 0, "Marketplace: Bidding with zero amount.");
 
         Bid memory newBid = Bid({ auctionId: _auctionId, bidder: _msgSender(), bidAmount: _bidAmount });
 
@@ -325,7 +331,10 @@ contract EnglishAuctionsLogic is IEnglishAuctions, ReentrancyGuardLogic, ERC2771
             _params.startTimestamp + 60 minutes >= block.timestamp && _params.startTimestamp < _params.endTimestamp,
             "Marketplace: invalid timestamps."
         );
-        require(_params.buyoutBidAmount >= _params.minimumBidAmount, "Marketplace: invalid bid amounts.");
+        require(
+            _params.buyoutBidAmount == 0 || _params.buyoutBidAmount >= _params.minimumBidAmount,
+            "Marketplace: invalid bid amounts."
+        );
     }
 
     /// @dev Processes an incoming bid in an auction.

contracts/marketplace/english-auctions/EnglishAuctionsStorage.sol

@@ -1,8 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.11;
 
 import { IEnglishAuctions } from "../IMarketplace.sol";
 
+/**
+ * @author  thirdweb.com
+ */
 library EnglishAuctionsStorage {
     bytes32 public constant ENGLISH_AUCTIONS_STORAGE_POSITION = keccak256("english.auctions.storage");
 

contracts/marketplace/entrypoint/InitStorage.sol

@@ -1,6 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.11;
 
+/**
+ * @author  thirdweb.com
+ */
 library InitStorage {
     /// @dev The location of the storage of the entrypoint contract's data.
     bytes32 constant INIT_STORAGE_POSITION = keccak256("init.storage");

contracts/marketplace/entrypoint/MarketplaceV3.sol

@@ -1,4 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
+// thirdweb Contract
+
 pragma solidity ^0.8.0;
 
 // ====== External imports ======
@@ -16,21 +18,8 @@ import "../../extension/plugin/ReentrancyGuardLogic.sol";
 import "../../extension/plugin/ERC2771ContextUpgradeableLogic.sol";
 
 /**
- *
- *      "Inherited by entrypoint" extensions.
- *      - ContractMetadata
- *      - PlatformFee
- *      - PermissionsEnumerable
- *      - ReentrancyGuard
- *      - ERC2771Context
- *      - Multicall
- *
- *      "NOT inherited by entrypoint" extensions.
- *      - DirectListings
- *      - EnglishAuctions
- *      - Offers
+ * @author  thirdweb.com
  */
-
 contract MarketplaceV3 is
     ContractMetadataLogic,
     PlatformFeeLogic,