Merge pull request #60 from trader-xyz/feat/order-filtering-arrays

Adds more filtering options for searching 0x v4 public orderbook

Author: johnrjj

package.json

@@ -73,6 +73,7 @@
     "isomorphic-unfetch": "^3.1.0",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
+    "query-string": "^7.1.1",
     "tiny-invariant": "^1.2.0",
     "tiny-warning": "^1.0.3",
     "uuid": "^8.3.2"

src/sdk/v4/orderbook.ts

@@ -1,6 +1,6 @@
 import unfetch from 'isomorphic-unfetch';
+import { stringify } from 'query-string';
 import type { SignedNftOrderV4, SignedNftOrderV4Serialized } from './types';
-import { stringify } from '../../utils/query-string';
 import { serializeNftOrder } from './pure';
 
 export const ORDERBOOK_API_ROOT_URL_PRODUCTION = 'https://api.trader.xyz';
@@ -74,25 +74,44 @@ const postOrderToOrderbook = async (
   return orderPostResult;
 };
 
+/**
+ * Available query parameters for searching the orderbook
+ */
 export interface SearchOrdersParams {
-  erc20Token?: string;
-  nftTokenId?: string;
-  nftToken?: string;
-  nftType?: string;
-  chainId?: string;
-  maker?: string;
-  taker?: string;
-  nonce?: string;
+  nftTokenId: string | string[];
+  erc20Token: string | string[];
+  nftToken: string | string[];
+  nftType: 'ERC721' | 'ERC1155';
+  chainId: string | number | string[] | number[];
+  maker: string;
+  taker: string;
+  nonce: string | string[];
+  offset: string | number;
+  limit: string | number;
+  sellOrBuyNft: 'sell' | 'buy';
+  direction: '0' | '1';
   // Defaults to only 'open' orders
-  status?: 'open' | 'filled' | 'expired' | 'cancelled' | 'all';
+  status: 'open' | 'filled' | 'expired' | 'cancelled' | 'all';
+  visibility: 'public' | 'private';
+  valid: 'valid' | 'all';
 }
 
+/**
+ * Search through the public hosted orderbook
+ * @param filters Optional query param filters
+ * @param requestOptions Fetch options/overrides
+ * @param fetchFn Optional fetch function override. Uses unfetch by default.
+ * @returns
+ */
 const searchOrderbook = async (
   filters?: Partial<SearchOrdersParams>,
   requestOptions?: Partial<OrderbookRequestOptions>,
   fetchFn: typeof unfetch = unfetch
 ): Promise<SearchOrdersResponsePayload> => {
-  const stringifiedQueryParams = stringify(filters ?? {});
+  // https://github.com/sindresorhus/query-string#arrayformat
+  const stringifiedQueryParams = stringify(filters ?? {}, {
+    arrayFormat: 'none',
+  });
 
   let rootUrl = requestOptions?.rootUrl ?? ORDERBOOK_API_ROOT_URL_PRODUCTION;
 

yarn.lock

@@ -3519,6 +3519,11 @@ fill-range@^7.0.1:
   dependencies:
     to-regex-range "^5.0.1"
 
+filter-obj@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/filter-obj/-/filter-obj-1.1.0.tgz#9b311112bc6c6127a16e016c6c5d7f19e0805c5b"
+  integrity sha1-mzERErxsYSehbgFsbF1/GeCAXFs=
+
 find-cache-dir@^3.3.1:
   version "3.3.2"
   resolved "https://registry.yarnpkg.com/find-cache-dir/-/find-cache-dir-3.3.2.tgz#b30c5b6eff0730731aea9bbd9dbecbd80256d64b"
@@ -5717,6 +5722,16 @@ qs@~6.5.2:
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.5.2.tgz#cb3ae806e8740444584ef154ce8ee98d403f3e36"
   integrity sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==
 
+query-string@^7.1.1:
+  version "7.1.1"
+  resolved "https://registry.yarnpkg.com/query-string/-/query-string-7.1.1.tgz#754620669db978625a90f635f12617c271a088e1"
+  integrity sha512-MplouLRDHBZSG9z7fpuAAcI7aAYjDLhtsiVZsevsfaHWDS2IDdORKbSd1kWUA+V4zyva/HZoSfpwnYMMQDhb0w==
+  dependencies:
+    decode-uri-component "^0.2.0"
+    filter-obj "^1.1.0"
+    split-on-first "^1.0.0"
+    strict-uri-encode "^2.0.0"
+
 queue-microtask@^1.2.2:
   version "1.2.3"
   resolved "https://registry.yarnpkg.com/queue-microtask/-/queue-microtask-1.2.3.tgz#4929228bbc724dfac43e0efb058caf7b6cfb6243"
@@ -6371,6 +6386,11 @@ spdx-license-ids@^3.0.0:
   resolved "https://registry.yarnpkg.com/spdx-license-ids/-/spdx-license-ids-3.0.10.tgz#0d9becccde7003d6c658d487dd48a32f0bf3014b"
   integrity sha512-oie3/+gKf7QtpitB0LYLETe+k8SifzsX4KixvpOsbI6S0kRiRQ5MKOio8eMSAKQ17N06+wdEOXRiId+zOxo0hA==
 
+split-on-first@^1.0.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/split-on-first/-/split-on-first-1.1.0.tgz#f610afeee3b12bce1d0c30425e76398b78249a5f"
+  integrity sha512-43ZssAJaMusuKWL8sKUBQXHWOpq8d6CfN/u1p4gUzfJkM05C8rxTmYrkIPTXapZpORA6LkkzcUulJ8FqA7Uudw==
+
 split-string@^3.0.1, split-string@^3.0.2:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/split-string/-/split-string-3.1.0.tgz#7cb09dda3a86585705c64b39a6466038682e8fe2"
@@ -6418,6 +6438,11 @@ stealthy-require@^1.1.1:
   resolved "https://registry.yarnpkg.com/stealthy-require/-/stealthy-require-1.1.1.tgz#35b09875b4ff49f26a777e509b3090a3226bf24b"
   integrity sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks=
 
+strict-uri-encode@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/strict-uri-encode/-/strict-uri-encode-2.0.0.tgz#b9c7330c7042862f6b142dc274bbcc5866ce3546"
+  integrity sha1-ucczDHBChi9rFC3CdLvMWGbONUY=
+
 string-format@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/string-format/-/string-format-2.0.0.tgz#f2df2e7097440d3b65de31b6d40d54c96eaffb9b"