Merge pull request #1191 from thesandboxgame/feat/marketplace-fee-side

feat: take fees only on ERC20

packages/marketplace/contracts/exchange/ExchangeCore.sol

@@ -6,8 +6,6 @@ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Ini
 import {LibFill} from "./libraries/LibFill.sol";
 import {IAssetMatcher} from "../interfaces/IAssetMatcher.sol";
 import {TransferExecutor} from "../transfer-manager/TransferExecutor.sol";
-import {LibFeeSide} from "../transfer-manager/lib/LibFeeSide.sol";
-import {LibDeal} from "../transfer-manager/lib/LibDeal.sol";
 import {LibAsset} from "../lib-asset/LibAsset.sol";
 import {LibOrder} from "../lib-order/LibOrder.sol";
 import {LibPart} from "../lib-part/LibPart.sol";
@@ -161,17 +159,17 @@ abstract contract ExchangeCore is Initializable, TransferExecutor, ITransferMana
 
         LibFill.FillResult memory newFill = _parseOrdersSetFillEmitMatch(sender, orderLeft, orderRight);
         doTransfers(
-            LibDeal.DealSide({
+            ITransferManager.DealSide({
                 asset: LibAsset.Asset({assetType: makeMatch, value: newFill.leftValue}),
                 payouts: _payToMaker(orderLeft),
                 from: orderLeft.maker
             }),
-            LibDeal.DealSide({
+            ITransferManager.DealSide({
                 asset: LibAsset.Asset(takeMatch, newFill.rightValue),
                 payouts: _payToMaker(orderRight),
                 from: orderRight.maker
             }),
-            LibFeeSide.getFeeSide(makeMatch.assetClass, takeMatch.assetClass)
+            LibAsset.getFeeSide(makeMatch.assetClass, takeMatch.assetClass)
         );
     }
 

packages/marketplace/contracts/lib-asset/LibAsset.sol

@@ -13,13 +13,15 @@ library LibAsset {
         ERC721_ASSET_CLASS,
         ERC1155_ASSET_CLASS
     }
-    bytes32 internal constant ASSET_TYPE_TYPEHASH = keccak256("AssetType(uint256 assetClass,bytes data)");
 
-    bytes32 internal constant ASSET_TYPEHASH =
-        keccak256("Asset(AssetType assetType,uint256 value)AssetType(uint256 assetClass,bytes data)");
+    enum FeeSide {
+        NONE,
+        LEFT,
+        RIGHT
+    }
 
     struct AssetType {
-        LibAsset.AssetClassType assetClass;
+        AssetClassType assetClass;
         bytes data;
     }
 
@@ -28,16 +30,35 @@ library LibAsset {
         uint256 value;
     }
 
-    ///    @notice calculate hash of asset type
-    ///    @param assetType to be hashed
-    ///    @return hash of assetType
+    bytes32 internal constant ASSET_TYPE_TYPEHASH = keccak256("AssetType(uint256 assetClass,bytes data)");
+
+    bytes32 internal constant ASSET_TYPEHASH =
+        keccak256("Asset(AssetType assetType,uint256 value)AssetType(uint256 assetClass,bytes data)");
+
+    /// @notice decides if the fees will be taken and from which side
+    /// @param leftClass left side asset class type
+    /// @param rightClass right side asset class type
+    /// @return side from which the fees will be taken or none
+    function getFeeSide(AssetClassType leftClass, AssetClassType rightClass) internal pure returns (FeeSide) {
+        if (leftClass == AssetClassType.ERC20_ASSET_CLASS && rightClass != AssetClassType.ERC20_ASSET_CLASS) {
+            return FeeSide.LEFT;
+        }
+        if (rightClass == AssetClassType.ERC20_ASSET_CLASS && leftClass != AssetClassType.ERC20_ASSET_CLASS) {
+            return FeeSide.RIGHT;
+        }
+        return FeeSide.NONE;
+    }
+
+    /// @notice calculate hash of asset type
+    /// @param assetType to be hashed
+    /// @return hash of assetType
     function hash(AssetType memory assetType) internal pure returns (bytes32) {
         return keccak256(abi.encode(ASSET_TYPE_TYPEHASH, assetType.assetClass, keccak256(assetType.data)));
     }
 
-    ///    @notice calculate hash of asset
-    ///    @param asset to be hashed
-    ///    @return hash of asset
+    /// @notice calculate hash of asset
+    /// @param asset to be hashed
+    /// @return hash of asset
     function hash(Asset memory asset) internal pure returns (bytes32) {
         return keccak256(abi.encode(ASSET_TYPEHASH, hash(asset.assetType), asset.value));
     }

packages/marketplace/contracts/mocks/LibFeeSideTest.sol

@@ -3,14 +3,13 @@
 pragma solidity 0.8.21;
 
 import {LibAsset} from "../lib-asset/LibAsset.sol";
-import {LibFeeSide} from "../transfer-manager/lib/LibFeeSide.sol";
 
 // TODO: MAKE THE TESTS!!!
 contract LibFeeSideTest {
     function getFeeSideTest(
         LibAsset.AssetClassType maker,
         LibAsset.AssetClassType taker
-    ) external pure returns (LibFeeSide.FeeSide) {
-        return LibFeeSide.getFeeSide(maker, taker);
+    ) external pure returns (LibAsset.FeeSide) {
+        return LibAsset.getFeeSide(maker, taker);
     }
 }

packages/marketplace/contracts/mocks/SimpleTransferManager.sol

@@ -2,13 +2,14 @@
 
 pragma solidity 0.8.21;
 
-import {ITransferManager, LibDeal, LibFeeSide} from "../transfer-manager/interfaces/ITransferManager.sol";
+import {ITransferManager} from "../transfer-manager/interfaces/ITransferManager.sol";
+import {LibAsset} from "../lib-asset/LibAsset.sol";
 
 abstract contract SimpleTransferManager is ITransferManager {
     function doTransfers(
-        LibDeal.DealSide memory left,
-        LibDeal.DealSide memory right,
-        LibFeeSide.FeeSide /* feeSide */
+        DealSide memory left,
+        DealSide memory right,
+        LibAsset.FeeSide /* feeSide */
     ) internal override {
         transfer(left.asset, left.from, right.from);
         transfer(right.asset, right.from, left.from);

packages/marketplace/contracts/transfer-manager/TransferManager.sol

@@ -6,7 +6,7 @@ import {ERC165Upgradeable, IERC165Upgradeable} from "@openzeppelin/contracts-upg
 import {IRoyaltiesProvider} from "../interfaces/IRoyaltiesProvider.sol";
 import {BpLibrary} from "../lib-bp/BpLibrary.sol";
 import {IRoyaltyUGC} from "./interfaces/IRoyaltyUGC.sol";
-import {ITransferManager, LibDeal, LibFeeSide} from "./interfaces/ITransferManager.sol";
+import {ITransferManager} from "./interfaces/ITransferManager.sol";
 import {LibAsset} from "../lib-asset/LibAsset.sol";
 import {LibPart} from "../lib-part/LibPart.sol";
 
@@ -99,15 +99,11 @@ abstract contract TransferManager is ERC165Upgradeable, ITransferManager {
     /// @notice executes transfers for 2 matched orders
     /// @param left DealSide from the left order (see LibDeal.sol)
     /// @param right DealSide from the right order (see LibDeal.sol)
-    function doTransfers(
-        LibDeal.DealSide memory left,
-        LibDeal.DealSide memory right,
-        LibFeeSide.FeeSide feeSide
-    ) internal override {
-        if (feeSide == LibFeeSide.FeeSide.LEFT) {
+    function doTransfers(DealSide memory left, DealSide memory right, LibAsset.FeeSide feeSide) internal override {
+        if (feeSide == LibAsset.FeeSide.LEFT) {
             doTransfersWithFees(left, right);
             transferPayouts(right.asset.assetType, right.asset.value, right.from, left.payouts);
-        } else if (feeSide == LibFeeSide.FeeSide.RIGHT) {
+        } else if (feeSide == LibAsset.FeeSide.RIGHT) {
             doTransfersWithFees(right, left);
             transferPayouts(left.asset.assetType, left.asset.value, left.from, right.payouts);
         } else {
@@ -119,7 +115,7 @@ abstract contract TransferManager is ERC165Upgradeable, ITransferManager {
     /// @notice executes the fee-side transfers (payment + fees)
     /// @param paymentSide DealSide of the fee-side order
     /// @param nftSide DealSide of the nft-side order
-    function doTransfersWithFees(LibDeal.DealSide memory paymentSide, LibDeal.DealSide memory nftSide) internal {
+    function doTransfersWithFees(DealSide memory paymentSide, DealSide memory nftSide) internal {
         uint256 rest = paymentSide.asset.value;
 
         if (_applyFees(paymentSide.from)) {

packages/marketplace/contracts/transfer-manager/interfaces/ITransferManager.sol

@@ -2,14 +2,16 @@
 
 pragma solidity 0.8.21;
 
-import {LibDeal} from "../lib/LibDeal.sol";
-import {LibFeeSide} from "../lib/LibFeeSide.sol";
 import {ITransferExecutor} from "./ITransferExecutor.sol";
+import {LibAsset} from "../../lib-asset/LibAsset.sol";
+import {LibPart} from "../../lib-part/LibPart.sol";
 
 abstract contract ITransferManager is ITransferExecutor {
-    function doTransfers(
-        LibDeal.DealSide memory left,
-        LibDeal.DealSide memory right,
-        LibFeeSide.FeeSide feeSide
-    ) internal virtual;
+    struct DealSide {
+        LibAsset.Asset asset;
+        LibPart.Part[] payouts;
+        address from;
+    }
+
+    function doTransfers(DealSide memory left, DealSide memory right, LibAsset.FeeSide feeSide) internal virtual;
 }