feat: TD-971 sdk changes for fees arrays (#891)

Author: reVrost

packages/orderbook/package.json

@@ -32,6 +32,7 @@
     "build": "NODE_ENV=production rollup --config rollup.config.js",
     "generate-types": "typechain --target=ethers-v5 --out-dir=src/typechain/types 'abi/*.json'",
     "lint": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0",
+    "lint:fix": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0 --fix",
     "run:demo": "jest --runInBand --testMatch \"**/?(*.)+(demo).[jt]s?(x)\"",
     "run:demo-expiry": "jest  --runInBand --testMatch \"**/(expiry.demo).[jt]s?(x)\"",
     "run:demo-fulfil": "jest --runInBand --testMatch \"**/(fulfil.demo).[jt]s?(x)\"",

packages/orderbook/src/api-client/api-client.test.ts

@@ -65,6 +65,7 @@ describe('ImmutableApiClient', () => {
           orderComponents,
           orderHash: '0x123',
           orderSignature: '0x123',
+          makerFees: [],
         });
 
         await expect(createListingPromise).rejects.toThrowError();
@@ -95,6 +96,7 @@ describe('ImmutableApiClient', () => {
           orderComponents,
           orderHash: '0x123',
           orderSignature: '0x123',
+          makerFees: [],
         });
 
         await expect(createListingPromise).rejects.toThrowError();
@@ -143,6 +145,7 @@ describe('ImmutableApiClient', () => {
           orderComponents,
           orderHash: '0x123',
           orderSignature: '0x123',
+          makerFees: [],
         });
 
         await expect(createListingPromise).rejects.toThrowError();
@@ -202,6 +205,7 @@ describe('ImmutableApiClient', () => {
           orderComponents,
           orderHash: '0x123',
           orderSignature: '0x123',
+          makerFees: [],
         });
 
         expect(orderResult.result.id).toEqual(orderId);

packages/orderbook/src/api-client/api-client.ts

@@ -1,10 +1,10 @@
 import {
-  ProtocolData,
+  Fee,
   ListingResult,
   ListListingsResult,
   ListTradeResult,
   OrdersService,
-  Fee,
+  ProtocolData,
   TradeResult,
 } from 'openapi/sdk';
 import {
@@ -24,8 +24,9 @@ export class ImmutableApiClient {
     private readonly seaportAddress: string,
   ) {}
 
-  async fulfillmentData(requests: Array<FulfillmentDataRequest>):
-  Promise<{ result: FulfillmentDataResult[] }> {
+  async fulfillmentData(
+    requests: Array<FulfillmentDataRequest>,
+  ): Promise<{ result: FulfillmentDataResult[] }> {
     return this.orderbookService.fulfillmentData({
       chainName: this.chainName,
       requestBody: requests,
@@ -68,7 +69,7 @@ export class ImmutableApiClient {
     orderHash,
     orderComponents,
     orderSignature,
-    makerFee,
+    makerFees,
   }: CreateListingParams): Promise<ListingResult> {
     if (orderComponents.offer.length !== 1) {
       throw new Error('Only one item can be listed at a time');
@@ -102,11 +103,11 @@ export class ImmutableApiClient {
             contract_address: orderComponents.consideration[0].token,
           },
         ],
-        fee: makerFee ? {
-          amount: makerFee.amount,
+        fees: makerFees.map((x) => ({
+          amount: x.amount,
           fee_type: FeeType.MAKER_MARKETPLACE as unknown as Fee.fee_type,
-          recipient: makerFee.recipient,
-        } : undefined,
+          recipient: x.recipient,
+        })),
         end_time: new Date(
           parseInt(`${orderComponents.endTime.toString()}000`, 10),
         ).toISOString(),

packages/orderbook/src/openapi/sdk/models/CreateListingRequestBody.ts

@@ -13,7 +13,10 @@ export type CreateListingRequestBody = {
    * Buy item for listing should either be NATIVE or ERC20 item
    */
   buy: Array<Item>;
-  fee?: Fee;
+  /**
+   * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+   */
+  fees: Array<Fee>;
   /**
    * Time after which the Order is considered expired
    */

packages/orderbook/src/openapi/sdk/models/FulfillmentDataRequest.ts

@@ -6,6 +6,6 @@ import type { Fee } from './Fee';
 
 export type FulfillmentDataRequest = {
   order_id: string;
-  fee?: Fee;
+  fees: Array<Fee>;
 };
 

packages/orderbook/src/orderbook.ts

@@ -6,21 +6,24 @@ import {
   OrderbookOverrides,
 } from './config/config';
 import { Fee as OpenApiFee } from './openapi/sdk';
-import { mapFromOpenApiOrder, mapFromOpenApiPage, mapFromOpenApiTrade } from './openapi/mapper';
+import {
+  mapFromOpenApiOrder,
+  mapFromOpenApiPage,
+  mapFromOpenApiTrade,
+} from './openapi/mapper';
 import { Seaport } from './seaport';
 import { SeaportLibFactory } from './seaport/seaport-lib-factory';
 import {
   CancelOrderResponse,
   CreateListingParams,
-  Fee,
   FeeType,
   FeeValue,
   FulfillOrderResponse,
+  ListingResult,
   ListListingsParams,
   ListListingsResult,
   ListTradesParams,
   ListTradesResult,
-  ListingResult,
   OrderStatus,
   PrepareListingParams,
   PrepareListingResponse,
@@ -175,16 +178,8 @@ export class Orderbook {
   async createListing(
     createListingParams: CreateListingParams,
   ): Promise<ListingResult> {
-    const makerFee: Fee | undefined = createListingParams.makerFee
-      ? {
-        ...createListingParams.makerFee,
-        type: FeeType.MAKER_MARKETPLACE,
-      }
-      : undefined;
-
     const apiListingResponse = await this.apiClient.createListing({
       ...createListingParams,
-      makerFee,
     });
 
     return {
@@ -203,18 +198,17 @@ export class Orderbook {
   async fulfillOrder(
     listingId: string,
     takerAddress: string,
-    takerFee?: FeeValue,
+    takerFees: FeeValue[],
   ): Promise<FulfillOrderResponse> {
     const fulfillmentDataRes = await this.apiClient.fulfillmentData([
       {
         order_id: listingId,
-        fee: takerFee
-          ? {
-            amount: takerFee.amount,
-            fee_type: FeeType.TAKER_MARKETPLACE as unknown as OpenApiFee.fee_type.TAKER_MARKETPLACE,
-            recipient: takerFee.recipient,
-          }
-          : undefined,
+        fees: takerFees.map((fee) => ({
+          amount: fee.amount,
+          fee_type:
+            FeeType.TAKER_MARKETPLACE as unknown as OpenApiFee.fee_type.TAKER_MARKETPLACE,
+          recipient: fee.recipient,
+        })),
       },
     ]);
 

packages/orderbook/src/types.ts

@@ -1,10 +1,6 @@
 import { OrderComponents } from '@opensea/seaport-js/lib/types';
 import { PopulatedTransaction, TypedDataDomain, TypedDataField } from 'ethers';
-import {
-  Fee as OpenapiFee,
-  OrdersService,
-  OrderStatus,
-} from './openapi/sdk';
+import { Fee as OpenapiFee, OrdersService, OrderStatus } from './openapi/sdk';
 
 // Strictly re-export only the OrderStatus enum from the openapi types
 export { OrderStatus } from './openapi/sdk';
@@ -48,7 +44,7 @@ export interface CreateListingParams {
   orderComponents: OrderComponents;
   orderHash: string;
   orderSignature: string;
-  makerFee?: FeeValue
+  makerFees: FeeValue[];
 }
 
 // Expose the list order filtering and ordering directly from the openAPI SDK, except
@@ -108,7 +104,7 @@ export interface SignableAction {
     domain: TypedDataDomain;
     types: Record<string, TypedDataField[]>;
     value: Record<string, any>;
-  }
+  };
 }
 
 export type Action = TransactionAction | SignableAction;
@@ -154,7 +150,7 @@ export interface Order {
     counter: string;
     seaportAddress: string;
     seaportVersion: string;
-  }
+  };
   salt: string;
   signature: string;
   status: OrderStatus;
@@ -190,10 +186,10 @@ export interface Trade {
   buy: (ERC20Item | NativeItem)[];
   sell: ERC721Item[];
   buyerFees: Fee[];
-  sellerAddress: string
-  buyerAddress: string
-  makerAddress: string
-  takerAddress: string
+  sellerAddress: string;
+  buyerAddress: string;
+  makerAddress: string;
+  takerAddress: string;
   /**
    * Time the on-chain event was indexed by the Immutable order book service
    */
@@ -215,7 +211,7 @@ export interface Trade {
      * The log index of the fulfillment event in a block (uint32 as string)
      */
     logIndex: string;
-  }
+  };
 }
 
 export interface TradeResult {