fix

Author: tpetrychyn

src/api/api.ts

@@ -34,7 +34,8 @@ import {
   GetBestListingResponse,
   GetOffersResponse,
   GetListingsResponse,
-  GetOrderByHashResponse,
+  Offer,
+  Listing,
   CollectionOffer,
   CollectionOrderByOption,
   CancelOrderResponse,
@@ -127,14 +128,14 @@ export class OpenSeaAPI {
    * @param orderHash The hash of the order to fetch
    * @param protocolAddress The address of the seaport contract
    * @param chain The chain where the order is located. Defaults to the chain set in the constructor.
-   * @returns The {@link GetOrderByHashResponse} returned by the API (can be Offer or Listing)
+   * @returns The {@link Offer} or {@link Listing} returned by the API
    * @throws An error if the order is not found
    */
   public async getOrderByHash(
     orderHash: string,
     protocolAddress: string,
     chain: Chain = this.chain,
-  ): Promise<GetOrderByHashResponse> {
+  ): Promise<Offer | Listing> {
     return this.ordersAPI.getOrderByHash(orderHash, protocolAddress, chain);
   }
 

src/api/orders.ts

@@ -6,7 +6,8 @@ import {
 import {
   GetOrdersResponse,
   CancelOrderResponse,
-  GetOrderByHashResponse,
+  Offer,
+  Listing,
 } from "./types";
 import {
   FulfillmentDataResponse,
@@ -82,9 +83,9 @@ export class OrdersAPI {
     orderHash: string,
     protocolAddress: string,
     chain: Chain = this.chain,
-  ): Promise<GetOrderByHashResponse> {
+  ): Promise<Offer | Listing> {
     const response = await this.fetcher.get<{
-      order: GetOrderByHashResponse;
+      order: Offer | Listing;
     }>(getOrderByHashPath(chain, protocolAddress, orderHash));
     return response.order;
   }

src/api/types.ts

@@ -243,13 +243,6 @@ export type GetBestOfferResponse = Offer | CollectionOffer;
  */
 export type GetBestListingResponse = Listing;
 
-/**
- * Response from OpenSea API for fetching an order by hash.
- * Can be either an Offer or a Listing.
- * @category API Response Types
- */
-export type GetOrderByHashResponse = Offer | Listing;
-
 /**
  * Response from OpenSea API for offchain canceling an order.
  * @category API Response Types

test/api/getOrderByHash.spec.ts

@@ -2,12 +2,7 @@ import { expect } from "chai";
 import { suite, test } from "mocha";
 import * as sinon from "sinon";
 import { OrdersAPI } from "../../src/api/orders";
-import {
-  GetOrderByHashResponse,
-  Offer,
-  Listing,
-  OrderStatus,
-} from "../../src/api/types";
+import { Offer, Listing, OrderStatus } from "../../src/api/types";
 import { OrderType, ProtocolData } from "../../src/orders/types";
 import { Chain } from "../../src/types";
 import { createMockFetcher } from "../fixtures/fetcher";
@@ -193,7 +188,7 @@ suite("API: OrdersAPI.getOrderByHash", () => {
 
     mockGet.resolves({ order: mockOffer });
 
-    const result: GetOrderByHashResponse = await ordersAPI.getOrderByHash(
+    const result: Offer | Listing = await ordersAPI.getOrderByHash(
       "0x123",
       "0xprotocol",
     );