@bosonprotocol/core-sdk 1.41.0-alpha.2 → 1.41.0-alpha.21

package/src/marketplaces/opensea.ts

@@ -4,7 +4,6 @@ import {
   FulfillmentDataResponse,
   GetNFTResponse,
   OrderAPIOptions,
-  OrderSide,
   OrderV2,
   OrdersQueryOptions,
   ProtocolData
@@ -18,6 +17,8 @@ import {
   Marketplace,
   MarketplaceType,
   Order,
+  OrderFilterOptions,
+  OrderSide,
   SignedOrder,
   Wrapper
 } from "./types";
@@ -68,6 +69,9 @@ export type OpenSeaSDKHandler = {
   api: {
     apiBaseUrl: string;
     getOrder(order: Omit<OrdersQueryOptions, "limit">): Promise<OrderV2>;
+    getOrders(
+      order: Omit<OrdersQueryOptions, "limit">
+    ): Promise<{ orders: OrderV2[] }>;
     generateFulfillmentData(
       fulfillerAddress: string,
       orderHash: string,
@@ -253,30 +257,38 @@ export class OpenSeaMarketplace extends Marketplace {
     const protocolAddress = listing.protocolAddress || this._contracts.seaport;
     if (!protocolAddress) {
       throw new Error(
-        `Seaport protocol address must be specified in Lsiting or CoreSDK config`
+        `Seaport protocol address must be specified in Listing or CoreSDK config`
       );
     }
 
     const osOrder = await this._handler.api.postOrder(order, {
       protocol: "seaport",
       protocolAddress,
-      side: OrderSide.BID
+      side: OrderSide.OFFER
     });
     return this.convertOsOrder(osOrder);
   }
 
-  public async buildAdvancedOrder(asset: {
-    contract: string;
-    tokenId: string;
-  }): Promise<AdvancedOrder> {
-    // Asumption: we're fulfilling a Bid Order (don't know if it makes sense with an Ask order)
+  public async buildAdvancedOrder(
+    asset: {
+      contract: string;
+      tokenId: string;
+      withWrapper?: boolean;
+    },
+    filter: OrderFilterOptions = {}
+  ): Promise<AdvancedOrder> {
+    // Assumption: we're fulfilling a Bid Order (don't know if it makes sense with an Ask order)
     const osOrder = await this._handler.api.getOrder({
       assetContractAddress: asset.contract,
       tokenId: asset.tokenId,
-      side: OrderSide.BID
+      side: OrderSide.OFFER,
+      ...filter
     });
+    const fulfillerAddress = asset.withWrapper
+      ? asset.contract // If the token is wrapped, the fulfiller is the wrapper contract itself
+      : this._contracts.priceDiscoveryClient; // otherwise the address of the PriceDiscoveryClient contract
     const ffd = await this._handler.api.generateFulfillmentData(
-      this._contracts.priceDiscoveryClient, // the address of the PriceDiscoveryClient contract, which will call the fulfilment method
+      fulfillerAddress,
       osOrder.orderHash,
       osOrder.protocolAddress,
       osOrder.side
@@ -291,13 +303,12 @@ export class OpenSeaMarketplace extends Marketplace {
     return inputData.orders[0];
   }
 
-  public async generateFulfilmentData(
-    asset: {
-      contract: string;
-      tokenId: string;
-    },
-    withWrapper = false
-  ): Promise<PriceDiscoveryStruct> {
+  public async generateFulfilmentData(asset: {
+    contract: string;
+    tokenId: string;
+    withWrapper?: boolean;
+  }): Promise<PriceDiscoveryStruct> {
+    const withWrapper = !!asset.withWrapper;
     const wrapper = withWrapper
       ? await this.getOrCreateVouchersWrapper(asset.contract)
       : undefined;
@@ -305,7 +316,7 @@ export class OpenSeaMarketplace extends Marketplace {
     const osOrder = await this._handler.api.getOrder({
       assetContractAddress: withWrapper ? wrapper.address : asset.contract,
       tokenId: asset.tokenId,
-      side: OrderSide.BID
+      side: OrderSide.OFFER
     });
     const ffd = await this._handler.api.generateFulfillmentData(
       withWrapper
@@ -438,7 +449,7 @@ export class OpenSeaMarketplace extends Marketplace {
     const osOrder = await this._handler.api.getOrder({
       assetContractAddress: wrapper.address, // Bid Order must be for the wrapped token
       tokenId: asset.tokenId,
-      side: OrderSide.BID
+      side: OrderSide.OFFER
     });
     const ffd = await this._handler.api.generateFulfillmentData(
       this._contracts.priceDiscoveryClient, // the address of the PriceDiscoveryClient contract, which will call the fulfilment method
@@ -473,7 +484,7 @@ export class OpenSeaMarketplace extends Marketplace {
       return undefined;
     }
     const orderInfo = this.extractOrderInfo(osOrder.protocolData.parameters);
-    const side = orderInfo.side === OrderSide.ASK ? Side.Ask : Side.Bid;
+    const side = orderInfo.side === OrderSide.LISTING ? Side.Ask : Side.Bid;
     return {
       offerer: orderInfo.offerer,
       side,
@@ -513,17 +524,17 @@ export class OpenSeaMarketplace extends Marketplace {
       (c) => c.itemType === ItemType.ERC721
     );
     const nftAsk = parameters.offer.find((c) => c.itemType === ItemType.ERC721);
-    if (side === OrderSide.BID && !nftBid) {
+    if (side === OrderSide.OFFER && !nftBid) {
       console.warn(`NFT not found in order consideration`);
     }
-    if (side === OrderSide.ASK && !nftAsk) {
+    if (side === OrderSide.LISTING && !nftAsk) {
       console.warn(`NFT not found in order offer`);
     }
     if (!side) {
       if (nftBid && !nftAsk) {
-        side = OrderSide.BID;
+        side = OrderSide.OFFER;
       } else if (!nftBid && nftAsk) {
-        side = OrderSide.ASK;
+        side = OrderSide.LISTING;
       } else if (nftBid && nftAsk) {
         console.warn(
           `NFT found in both consideration and offer. Unable to detect the order side`
@@ -534,7 +545,7 @@ export class OpenSeaMarketplace extends Marketplace {
         );
       }
     }
-    if (side === OrderSide.BID) {
+    if (side === OrderSide.OFFER) {
       price = parameters.offer
         .filter((c) => c.itemType === ItemType.ERC20)
         .reduce(
@@ -583,12 +594,14 @@ export class OpenSeaMarketplace extends Marketplace {
       contract: string;
       tokenId: string;
     },
-    side: Side
+    side: Side,
+    filter: OrderFilterOptions = {}
   ): Promise<SignedOrder> {
     const osOrder = await this._handler.api.getOrder({
       assetContractAddress: asset.contract,
       tokenId: asset.tokenId,
-      side: side === Side.Ask ? OrderSide.ASK : OrderSide.BID
+      side: side === Side.Ask ? OrderSide.LISTING : OrderSide.OFFER,
+      ...filter
     });
     return osOrder
       ? {
@@ -597,4 +610,24 @@ export class OpenSeaMarketplace extends Marketplace {
         }
       : undefined;
   }
+
+  public async getOrders(
+    asset: {
+      contract: string;
+      tokenIds: string[];
+    },
+    side: Side,
+    filter: OrderFilterOptions = {}
+  ): Promise<SignedOrder[]> {
+    const { orders } = await this._handler.api.getOrders({
+      assetContractAddress: asset.contract,
+      tokenIds: asset.tokenIds,
+      side: side === Side.Ask ? OrderSide.LISTING : OrderSide.OFFER,
+      ...filter
+    });
+    return orders.map((osOrder) => ({
+      ...this.convertOsOrder(osOrder),
+      signature: osOrder.protocolData?.signature
+    }));
+  }
 }

package/src/marketplaces/types.ts

@@ -16,7 +16,7 @@ export enum MarketplaceType {
   OPENSEA
 }
 
-export enum OrderSide {}
+export { OrderSide } from "opensea-js";
 
 export type MarketplaceHandler = OpenSeaSDKHandler | DefaultHandler;
 
@@ -64,6 +64,12 @@ export abstract class Wrapper {
   public abstract get address(): string;
 }
 
+export type OrderFilterOptions = {
+  maker?: string;
+  listedAfter?: number | string;
+  listedBefore?: number | string;
+};
+
 export abstract class Marketplace {
   constructor(protected _type: MarketplaceType) {}
   public abstract createListing(listing: Listing): Promise<Order>;
@@ -73,19 +79,30 @@ export abstract class Marketplace {
       contract: string;
       tokenId: string;
     },
-    side: Side
+    side: Side,
+    filter?: OrderFilterOptions
   ): Promise<SignedOrder>;
-  public abstract generateFulfilmentData(
+  public abstract getOrders(
     asset: {
       contract: string;
-      tokenId: string;
+      tokenIds: string[];
     },
-    withWrapper?: boolean
-  ): Promise<PriceDiscoveryStruct>;
-  public abstract buildAdvancedOrder(asset: {
+    side: Side,
+    filter?: OrderFilterOptions
+  ): Promise<SignedOrder[]>;
+  public abstract generateFulfilmentData(asset: {
     contract: string;
     tokenId: string;
-  }): Promise<AdvancedOrder>;
+    withWrapper?: boolean;
+  }): Promise<PriceDiscoveryStruct>;
+  public abstract buildAdvancedOrder(
+    asset: {
+      contract: string;
+      tokenId: string;
+      withWrapper?: boolean;
+    },
+    filter?: OrderFilterOptions
+  ): Promise<AdvancedOrder>;
   public abstract wrapVouchers(
     contract: string,
     tokenIds: string[]