fix: exclude marketplace fees from private listings (#1714)

Author: ryanio

src/constants.ts

@@ -28,3 +28,6 @@ export const SHARED_STOREFRONT_ADDRESSES = [
 ].map((address) => address.toLowerCase());
 export const SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS =
   "0xa604060890923ff400e8c6f5290461a83aedacec";
+
+export const OPENSEA_FEE_RECIPIENT =
+  "0x0000a26b00c1f0df003000390027140000faa719";

src/sdk.ts

@@ -27,6 +27,7 @@ import {
   INVERSE_BASIS_POINT,
   ENGLISH_AUCTION_ZONE_MAINNETS,
   ENGLISH_AUCTION_ZONE_TESTNETS,
+  OPENSEA_FEE_RECIPIENT,
 } from "./constants";
 import {
   constructPrivateListingCounterOrder,
@@ -44,6 +45,7 @@ import {
   EventData,
   EventType,
   Chain,
+  Fee,
   OpenSeaAPIConfig,
   OpenSeaCollection,
   OrderSide,
@@ -260,18 +262,25 @@ export class OpenSeaSDK {
     startAmount,
     endAmount,
     excludeOptionalCreatorFees,
+    isPrivateListing = false,
   }: {
     collection: OpenSeaCollection;
     seller?: string;
     paymentTokenAddress: string;
     startAmount: bigint;
     endAmount?: bigint;
     excludeOptionalCreatorFees?: boolean;
+    isPrivateListing?: boolean;
   }): Promise<ConsiderationInputItem[]> {
     let collectionFees = collection.fees;
     if (excludeOptionalCreatorFees) {
       collectionFees = collectionFees.filter((fee) => fee.required);
     }
+    if (isPrivateListing) {
+      collectionFees = collectionFees.filter((fee) =>
+        this.isNotMarketplaceFee(fee),
+      );
+    }
     const collectionFeesBasisPoints = totalBasisPointsForFees(collectionFees);
     const sellerBasisPoints = INVERSE_BASIS_POINT - collectionFeesBasisPoints;
 
@@ -302,6 +311,10 @@ export class OpenSeaSDK {
     return considerationItems;
   }
 
+  private isNotMarketplaceFee(fee: Fee): boolean {
+    return fee.recipient.toLowerCase() !== OPENSEA_FEE_RECIPIENT.toLowerCase();
+  }
+
   private getNFTItems(
     nfts: NFT[],
     quantities: bigint[] = [],
@@ -507,6 +520,7 @@ export class OpenSeaSDK {
       startAmount: basePrice,
       endAmount: endPrice,
       excludeOptionalCreatorFees,
+      isPrivateListing: !!buyerAddress,
     });
 
     if (buyerAddress) {

test/integration/postOrder.spec.ts

@@ -9,17 +9,16 @@ import {
   sdk,
   sdkPolygon,
   walletAddress,
+  getRandomExpiration,
 } from "./setup";
 import { ENGLISH_AUCTION_ZONE_MAINNETS } from "../../src/constants";
 import { getWETHAddress } from "../../src/utils";
 import { OFFER_AMOUNT } from "../utils/constants";
 import { expectValidOrder } from "../utils/utils";
 
-const ONE_HOUR = Math.floor(Date.now() / 1000) + 3600;
-const expirationTime = ONE_HOUR;
-
 suite("SDK: order posting", () => {
   test("Post Offer - Mainnet", async () => {
+    const expirationTime = getRandomExpiration();
     const offer = {
       accountAddress: walletAddress,
       startAmount: +OFFER_AMOUNT,
@@ -41,6 +40,7 @@ suite("SDK: order posting", () => {
   });
 
   test("Post Offer - Polygon", async () => {
+    const expirationTime = getRandomExpiration();
     const offer = {
       accountAddress: walletAddress,
       startAmount: +OFFER_AMOUNT,
@@ -58,12 +58,13 @@ suite("SDK: order posting", () => {
     if (!TOKEN_ADDRESS_MAINNET || !TOKEN_ID_MAINNET) {
       this.skip();
     }
+    const expirationTime = getRandomExpiration();
     const listing = {
       accountAddress: walletAddress,
       startAmount: LISTING_AMOUNT,
       asset: {
-        tokenAddress: TOKEN_ADDRESS_MAINNET as string,
-        tokenId: TOKEN_ID_MAINNET as string,
+        tokenAddress: TOKEN_ADDRESS_MAINNET,
+        tokenId: TOKEN_ID_MAINNET,
       },
       expirationTime,
     };
@@ -78,12 +79,13 @@ suite("SDK: order posting", () => {
     if (!TOKEN_ADDRESS_MAINNET || !TOKEN_ID_MAINNET) {
       this.skip();
     }
+    const expirationTime = getRandomExpiration();
     const listing = {
       accountAddress: walletAddress,
       startAmount: LISTING_AMOUNT,
       asset: {
-        tokenAddress: TOKEN_ADDRESS_MAINNET as string,
-        tokenId: TOKEN_ID_MAINNET as string,
+        tokenAddress: TOKEN_ADDRESS_MAINNET,
+        tokenId: TOKEN_ID_MAINNET,
       },
       englishAuction: true,
       expirationTime,
@@ -105,6 +107,7 @@ suite("SDK: order posting", () => {
   });
 
   test.skip("Post Listing - Polygon", async function () {
+    const expirationTime = getRandomExpiration();
     const listing = {
       accountAddress: walletAddress,
       paymentTokenAddress: getWETHAddress(sdkPolygon.chain),
@@ -122,6 +125,7 @@ suite("SDK: order posting", () => {
   test.skip("Post Collection Offer - Mainnet", async () => {
     const collection = await sdk.api.getCollection("cool-cats-nft");
     const paymentTokenAddress = getWETHAddress(sdk.chain);
+    const expirationTime = getRandomExpiration();
     const postOrderRequest = {
       collectionSlug: collection.collection,
       accountAddress: walletAddress,
@@ -149,6 +153,7 @@ suite("SDK: order posting", () => {
   test.skip("Post Collection Offer - Polygon", async () => {
     const collection = await sdkPolygon.api.getCollection("arttoken-1155-4");
     const paymentTokenAddress = getWETHAddress(sdkPolygon.chain);
+    const expirationTime = getRandomExpiration();
     const postOrderRequest = {
       collectionSlug: collection.collection,
       accountAddress: walletAddress,
@@ -180,6 +185,7 @@ suite("SDK: order posting", () => {
   test("Post Trait Offer - Ethereum", async () => {
     const collection = await sdk.api.getCollection("cool-cats-nft");
     const paymentTokenAddress = getWETHAddress(sdk.chain);
+    const expirationTime = getRandomExpiration();
     const postOrderRequest = {
       collectionSlug: collection.collection,
       accountAddress: walletAddress,

test/integration/privateListing.spec.ts

@@ -0,0 +1,71 @@
+import { expect } from "chai";
+import { suite, test } from "mocha";
+import {
+  getRandomExpiration,
+  LISTING_AMOUNT,
+  TOKEN_ADDRESS_MAINNET,
+  TOKEN_ID_MAINNET,
+  sdk,
+  walletAddress,
+} from "./setup";
+import { OPENSEA_FEE_RECIPIENT } from "../../src/constants";
+import { expectValidOrder } from "../utils/utils";
+
+suite("SDK: Private Listings Integration", () => {
+  test("Post Private Listing - Mainnet", async function () {
+    if (!TOKEN_ADDRESS_MAINNET || !TOKEN_ID_MAINNET) {
+      this.skip();
+    }
+
+    const buyerAddress = "0x0000000000000000000000000000000000000001";
+    const expirationTime = getRandomExpiration();
+
+    const privateListing = {
+      accountAddress: walletAddress,
+      startAmount: LISTING_AMOUNT,
+      asset: {
+        tokenAddress: TOKEN_ADDRESS_MAINNET,
+        tokenId: TOKEN_ID_MAINNET,
+      },
+      buyerAddress,
+      expirationTime,
+    };
+
+    const order = await sdk.createListing(privateListing);
+    expectValidOrder(order);
+
+    expect(order.protocolData.parameters.consideration).to.exist;
+
+    const hasMarketplaceFee = order.protocolData.parameters.consideration.some(
+      (item: { recipient?: string }) =>
+        item.recipient?.toLowerCase() === OPENSEA_FEE_RECIPIENT.toLowerCase(),
+    );
+
+    expect(hasMarketplaceFee).to.be.false;
+  });
+
+  test("Post Regular Listing - Mainnet (for comparison)", async function () {
+    if (!TOKEN_ADDRESS_MAINNET || !TOKEN_ID_MAINNET) {
+      this.skip();
+    }
+
+    const expirationTime = getRandomExpiration();
+    const regularListing = {
+      accountAddress: walletAddress,
+      startAmount: LISTING_AMOUNT,
+      asset: {
+        tokenAddress: TOKEN_ADDRESS_MAINNET,
+        tokenId: TOKEN_ID_MAINNET,
+      },
+      expirationTime,
+    };
+
+    const order = await sdk.createListing(regularListing);
+    expectValidOrder(order);
+
+    expect(order.protocolData.parameters.consideration).to.exist;
+    expect(
+      order.protocolData.parameters.consideration.length,
+    ).to.be.greaterThan(0);
+  });
+});

test/integration/setup.ts

@@ -1,3 +1,4 @@
+import { randomBytes } from "crypto";
 import { ethers } from "ethers";
 import { OpenSeaSDK } from "../../src/sdk";
 import { Chain } from "../../src/types";
@@ -14,8 +15,9 @@ for (const envVar of ["WALLET_PRIV_KEY"]) {
   }
 }
 
-export const TOKEN_ADDRESS_MAINNET = process.env.SELL_ORDER_CONTRACT_ADDRESS;
-export const TOKEN_ID_MAINNET = process.env.SELL_ORDER_TOKEN_ID;
+export const TOKEN_ADDRESS_MAINNET = process.env
+  .SELL_ORDER_CONTRACT_ADDRESS as string;
+export const TOKEN_ID_MAINNET = process.env.SELL_ORDER_TOKEN_ID as string;
 export const TOKEN_ADDRESS_POLYGON =
   process.env.SELL_ORDER_CONTRACT_ADDRESS_POLYGON;
 export const TOKEN_ID_POLYGON = process.env.SELL_ORDER_TOKEN_ID_POLYGON;
@@ -49,3 +51,22 @@ export const sdkPolygon = new OpenSeaSDK(
   },
   (line) => console.info(`POLYGON: ${line}`),
 );
+
+export const getRandomExpiration = (): number => {
+  const now = Math.floor(Date.now() / 1000);
+  const fifteenMinutes = 15 * 60;
+  const oneHour = 60 * 60;
+  const range = oneHour - fifteenMinutes + 1;
+
+  const maxValue = 0xffffffff; // 2^32 - 1
+  const rejectionThreshold = maxValue - (maxValue % range);
+
+  let randomValue: number;
+  do {
+    const randomBuffer = randomBytes(4);
+    randomValue = randomBuffer.readUInt32BE(0);
+  } while (randomValue >= rejectionThreshold);
+
+  const randomSeconds = (randomValue % range) + fifteenMinutes;
+  return now + randomSeconds;
+};