bugfix: Fix native currency tip amount scaling logic for partial fills when using fulfillOrders

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensea/seaport-js",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "[Seaport](https://github.com/ProjectOpenSea/seaport) is a new marketplace protocol for safely and efficiently buying and selling NFTs. This is a TypeScript library intended to make interfacing with the contract reasonable and easy.",
   "license": "MIT",
   "author": "OpenSea Developers",

src/seaport.ts

@@ -52,9 +52,8 @@ import {
   shouldUseBasicFulfill,
   validateAndSanitizeFromOrderStatus,
 } from "./utils/fulfill";
-import { getMaximumSizeForOrder, isCurrencyItem } from "./utils/item";
+import { isCurrencyItem } from "./utils/item";
 import {
-  adjustTipsForPartialFills,
   areAllCurrenciesSame,
   deductFees,
   feeToConsiderationItem,
@@ -1049,16 +1048,6 @@ export class Seaport {
           offererBalancesAndApprovals: offerersBalancesAndApprovals[index],
           offererOperator: allOffererOperators[index],
         };
-        if (order.tips.length > 0) {
-          order.tips = adjustTipsForPartialFills(
-            order.tips,
-            order.unitsToFill || 1,
-            // Max total amount to fulfill for scaling
-            getMaximumSizeForOrder({
-              ...order.order,
-            }),
-          );
-        }
 
         return order;
       },

src/utils/fulfill.ts

@@ -574,6 +574,31 @@ export function fulfillAvailableOrders({
     ),
   }));
 
+  const adjustTips = (orderMetadata: {
+    order: Order;
+    unitsToFill?: BigNumberish;
+    orderStatus: OrderStatus;
+    offerCriteria: InputCriteria[];
+    considerationCriteria: InputCriteria[];
+    tips: ConsiderationItem[];
+    extraData: string;
+    offererBalancesAndApprovals: BalancesAndApprovals;
+    offererOperator: string;
+  }): ConsiderationItem[] => {
+    if (!orderMetadata.tips || !orderMetadata.tips.length) {
+      return [];
+    }
+
+    // Max total amount to fulfill for scaling
+    const maxUnits = getMaximumSizeForOrder(orderMetadata.order);
+
+    return adjustTipsForPartialFills(
+      orderMetadata.tips,
+      orderMetadata.unitsToFill || 1,
+      maxUnits,
+    );
+  };
+
   const ordersMetadataWithAdjustedFills = sanitizedOrdersMetadata.map(
     (orderMetadata) => ({
       ...orderMetadata,
@@ -589,6 +614,7 @@ export function fulfillAvailableOrders({
             totalFilled: orderMetadata.orderStatus.totalFilled,
             totalSize: orderMetadata.orderStatus.totalSize,
           }),
+      tips: adjustTips(orderMetadata),
     }),
   );
 

test/partial-fulfill.spec.ts

@@ -24,6 +24,7 @@ describeWithFixture(
     let fulfiller: Signer;
 
     let fulfillStandardOrderSpy: SinonSpy;
+    let fulfillAvailableOrdersSpy: SinonSpy;
     let standardCreateOrderInput: CreateOrderInput;
     let secondTestErc1155: TestERC1155;
 
@@ -33,6 +34,7 @@ describeWithFixture(
       [offerer, zone, fulfiller] = await ethers.getSigners();
 
       fulfillStandardOrderSpy = sinon.spy(fulfill, "fulfillStandardOrder");
+      fulfillAvailableOrdersSpy = sinon.spy(fulfill, "fulfillAvailableOrders");
 
       const TestERC1155 = await ethers.getContractFactory("TestERC1155");
       secondTestErc1155 = await TestERC1155.deploy();
@@ -41,6 +43,7 @@ describeWithFixture(
 
     afterEach(() => {
       fulfillStandardOrderSpy.restore();
+      fulfillAvailableOrdersSpy.restore();
     });
 
     describe("An ERC1155 is partially transferred", () => {
@@ -304,7 +307,7 @@ describeWithFixture(
             fulfillReceipt: receipt!,
           });
 
-          expect(fulfillStandardOrderSpy.calledOnce);
+          expect(fulfillAvailableOrdersSpy.calledOnce).to.be.true;
         });
 
         it("ERC1155 <=> ETH adjust tips correctly with low denomination", async () => {