Refactor HostIt fee logic and update interface docs

Replaced dynamic HostIt fee basis points with a constant, refactored fee calculation to use pure functions, and removed related setter logic. Updated IMarketplace interface with detailed documentation and adjusted function signatures. Added HOST_IT_SALT to .env.example for deployment configuration.

Author: dadadave80

.env.example

@@ -27,4 +27,7 @@ AVALANCHE_FUJI_VERIFIER_URL=https://api.routescan.io/v2/network/testnet/evm/4311
 
 # ACCOUNTS
 ACCOUNT=
-WALLET_ADDR=
+WALLET_ADDR=
+
+# SALT
+HOST_IT_SALT=

script/DeployHostItTickets.s.sol

@@ -49,7 +49,9 @@ contract DeployHostItTicketsTest is Script, DeployHostItTicketsHelper {
 
         // Deploy HostItTickets diamond
         hostIt_ = address(
-            new HostItTickets(
+            new HostItTickets{
+                salt: vm.envBytes32("HOST_IT_SALT")
+            }(
                 _createFacetCuts(
                     diamondCutFacet, diamondLoupeFacet, ownableRolesFacet, factoryFacet, checkInFacet, marketplaceFacet
                 ),

src/facets/MarketplaceFacet.sol

@@ -64,14 +64,14 @@ contract MarketplaceFacet is IMarketplace {
         return _feeType._getHostItBalance();
     }
 
-    function calculateHostItFee(uint256 _fee) external view returns (uint256) {
-        return _fee._calculateHostItFee();
-    }
-
     //*//////////////////////////////////////////////////////////////////////////
     //                               PURE FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*//
 
+    function getHostItFee(uint256 _fee) external pure returns (uint256) {
+        return _fee._getHostItFee();
+    }
+
     function getRefundPeriod() external pure returns (uint256) {
         return LibMarketplace.REFUND_PERIOD;
     }

src/inits/HostItInit.sol

@@ -1,20 +1,16 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 pragma solidity 0.8.30;
 
-import {LibDiamond} from "@diamond/libraries/LibDiamond.sol";
 import {FeeType} from "@ticket-storage/MarketplaceStorage.sol";
-import {ITicket} from "@ticket/interfaces/ITicket.sol";
 import {LibFactory} from "@ticket/libs/LibFactory.sol";
 import {LibMarketplace} from "@ticket/libs/LibMarketplace.sol";
 
 event HostItInitialized();
 
 contract HostItInit {
     function initHostIt(address _ticketProxy, FeeType[] calldata _feeTypes, address[] calldata _tokens) public {
-        LibDiamond._diamondStorage().supportedInterfaces[type(ITicket).interfaceId] = true;
         LibFactory._factoryStorage().ticketProxy = _ticketProxy;
         LibMarketplace._setFeeTokenAddresses(_feeTypes, _tokens);
-        LibMarketplace._setHostItFeeBps(300);
         emit HostItInitialized();
     }
 }

src/interfaces/IMarketplace.sol

@@ -3,44 +3,98 @@ pragma solidity 0.8.30;
 
 import {FeeType} from "@ticket-storage/MarketplaceStorage.sol";
 
+/// @title Marketplace interface
+/// @notice Interface for the Marketplace facet
+/// @author HostIt Protocol
 interface IMarketplace {
     //*//////////////////////////////////////////////////////////////////////////
     //                             EXTERNAL FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*//
 
+    /// @notice Mints a ticket for the specified buyer
+    /// @param ticketId The ID of the ticket to mint
+    /// @param feeType The type of fee to use for the ticket
+    /// @param buyer The address of the buyer
+    /// @return The token ID of the minted ticket
     function mintTicket(uint64 ticketId, FeeType feeType, address buyer) external payable returns (uint40);
 
+    /// @notice Sets the fees for the specified ticket
+    /// @param ticketId The ID of the ticket to set fees for
+    /// @param feeTypes The types of fees to set
+    /// @param fees The fees to set
     function setTicketFees(uint64 ticketId, FeeType[] calldata feeTypes, uint256[] calldata fees) external;
 
+    /// @notice Claims a refund for the specified ticket
+    /// @param ticketId The ID of the ticket to claim a refund for
+    /// @param feeType The type of fee to claim a refund for
+    /// @param tokenId The token ID of the ticket to claim a refund for
+    /// @param to The address to send the refund to
     function claimRefund(uint64 ticketId, FeeType feeType, uint256 tokenId, address to) external;
 
+    /// @notice Withdraws the ticket balance for the specified ticket
+    /// @param ticketId The ID of the ticket to withdraw the balance for
+    /// @param feeType The type of fee to withdraw the balance for
+    /// @param to The address to send the balance to
     function withdrawTicketBalance(uint64 ticketId, FeeType feeType, address to) external;
 
+    /// @notice Withdraws the HostIt balance for the specified fee type
+    /// @param feeType The type of fee to withdraw the balance for
+    /// @param to The address to send the balance to
     function withdrawHostItBalance(FeeType feeType, address to) external;
 
     //*//////////////////////////////////////////////////////////////////////////
     //                               VIEW FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*//
 
+    /// @notice Checks if the specified fee type is enabled for the specified ticket
+    /// @param ticketId The ID of the ticket to check
+    /// @param feeType The type of fee to check
+    /// @return True if the fee type is enabled, false otherwise
     function isFeeEnabled(uint64 ticketId, FeeType feeType) external view returns (bool);
 
+    /// @notice Gets the address of the fee token for the specified fee type
+    /// @param feeType The type of fee to get the address for
+    /// @return The address of the fee token
     function getFeeTokenAddress(FeeType feeType) external view returns (address);
 
+    /// @notice Gets the fee for the specified ticket and fee type
+    /// @param ticketId The ID of the ticket to get the fee for
+    /// @param feeType The type of fee to get
+    /// @return The fee for the ticket and fee type
     function getTicketFee(uint64 ticketId, FeeType feeType) external view returns (uint256);
+
+    /// @notice Gets the fees for the specified ticket
+    /// @param ticketId The ID of the ticket to get the fees for
+    /// @param feeType The type of fee to get
+    /// @return ticketFee The ticket fee for the ticket
+    /// @return hostItFee The HostIt fee for the ticket
+    /// @return totalFee The total fee for the ticket
     function getAllFees(uint64 ticketId, FeeType feeType)
         external
         view
         returns (uint256 ticketFee, uint256 hostItFee, uint256 totalFee);
 
+    /// @notice Gets the balance of the specified ticket for the specified fee type
+    /// @param ticketId The ID of the ticket to get the balance for
+    /// @param feeType The type of fee to get the balance for
+    /// @return The balance of the ticket for the fee type
     function getTicketBalance(uint64 ticketId, FeeType feeType) external view returns (uint256);
 
+    /// @notice Gets the balance of HostIt for the specified fee type
+    /// @param feeType The type of fee to get the balance for
+    /// @return The balance of HostIt for the fee type
     function getHostItBalance(FeeType feeType) external view returns (uint256);
 
-    function calculateHostItFee(uint256 fee) external view returns (uint256);
-
     //*//////////////////////////////////////////////////////////////////////////
     //                               PURE FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*//
 
+    /// @notice Calculates the HostIt fee for the specified fee
+    /// @param fee The fee to calculate the HostIt fee for
+    /// @return The HostIt fee for the fee
+    function getHostItFee(uint256 fee) external pure returns (uint256);
+
+    /// @notice Gets the refund period
+    /// @return The refund period
     function getRefundPeriod() external pure returns (uint256);
 }

src/libs/LibMarketplace.sol

@@ -220,12 +220,6 @@ library LibMarketplace {
         emit TicketFeeAddressSet(_feeTypes, _tokenAddresses);
     }
 
-    function _setHostItFeeBps(uint16 _hostItFeePercentage) internal {
-        if (_hostItFeePercentage > HOSTIT_FEE_BPS) revert InvalidHostItFeeBps();
-        _marketplaceStorage().hostItFeeBps = _hostItFeePercentage;
-        emit HostItFeeBpsSet(_hostItFeePercentage);
-    }
-
     //*//////////////////////////////////////////////////////////////////////////
     //                               VIEW FUNCTIONS
     //////////////////////////////////////////////////////////////////////////*//
@@ -273,7 +267,7 @@ library LibMarketplace {
         returns (uint256 ticketFee_, uint256 hostItFee_, uint256 totalFee_)
     {
         ticketFee_ = _getTicketFee(_ticketId, _feeType);
-        hostItFee_ = _calculateHostItFee(ticketFee_);
+        hostItFee_ = _getHostItFee(ticketFee_);
         totalFee_ = ticketFee_ + hostItFee_;
     }
 
@@ -283,7 +277,7 @@ library LibMarketplace {
         returns (uint256 ticketFee_, uint256 hostItFee_, uint256 totalFee_)
     {
         ticketFee_ = _getTicketFee(_ms, _ticketId, _feeType);
-        hostItFee_ = _calculateHostItFee(_ms, ticketFee_);
+        hostItFee_ = _getHostItFee(ticketFee_);
         totalFee_ = ticketFee_ + hostItFee_;
     }
 
@@ -311,12 +305,8 @@ library LibMarketplace {
         if (_address.code.length > 0) revert ContractNotAllowed();
     }
 
-    function _calculateHostItFee(uint256 _fee) internal view returns (uint256) {
-        return _calculateHostItFee(_marketplaceStorage(), _fee);
-    }
-
-    function _calculateHostItFee(MarketplaceStorage storage _ms, uint256 _fee) internal view returns (uint256) {
-        return ((_fee * _ms.hostItFeeBps) / FEE_BASIS_POINTS);
+    function _getHostItFee(uint256 _fee) internal pure returns (uint256) {
+        return ((_fee * HOSTIT_FEE_BPS) / FEE_BASIS_POINTS);
     }
 
     //*//////////////////////////////////////////////////////////////////////////