more configurability

Author: johnrjj

src/sdk/v4/NftSwapV4.ts

@@ -45,13 +45,18 @@ import type {
   NftOrderV4Serialized,
   OrderStructOptionsCommonStrict,
   SignedNftOrderV4,
+  SignedNftOrderV4Serialized,
   SigningOptions,
 } from './types';
 import {
   ERC1155_TRANSFER_FROM_DATA,
   ERC721_TRANSFER_FROM_DATA,
 } from './nft-safe-transfer-from-data';
 import addresses from './addresses.json';
+import {
+  ORDERBOOK_API_ROOT_URL_PRODUCTION,
+  postOrderToOrderbook,
+} from './orderbook';
 
 export enum SupportedChainIdsV4 {
   Ropsten = 3,
@@ -121,6 +126,7 @@ export interface INftSwapV4 extends BaseNftSwap {
 
 export interface AdditionalSdkConfig {
   zeroExExchangeProxyContractAddress: string;
+  orderbookRootUrl: string;
 }
 
 class NftSwapV4 implements INftSwapV4 {
@@ -130,6 +136,8 @@ class NftSwapV4 implements INftSwapV4 {
   public exchangeProxy: IZeroEx;
   public exchangeProxyContractAddress: string;
 
+  public orderbookRootUrl: string;
+
   constructor(
     provider: BaseProvider,
     signer: Signer,
@@ -155,6 +163,9 @@ class NftSwapV4 implements INftSwapV4 {
 
     this.exchangeProxyContractAddress = zeroExExchangeContractAddress;
 
+    this.orderbookRootUrl =
+      additionalConfig?.orderbookRootUrl ?? ORDERBOOK_API_ROOT_URL_PRODUCTION;
+
     this.exchangeProxy = IZeroEx__factory.connect(
       zeroExExchangeContractAddress,
       signer ?? provider
@@ -567,6 +578,18 @@ class NftSwapV4 implements INftSwapV4 {
     console.log('unsupported order', signedOrder);
     throw new Error('unsupport signedOrder type');
   };
+
+  postOrder = (
+    signedOrder: SignedNftOrderV4 | SignedNftOrderV4Serialized,
+    chainId: string,
+    metadata?: Record<string, string>
+  ) => {
+    postOrderToOrderbook(signedOrder, chainId, metadata, {
+      rootUrl: this.orderbookRootUrl,
+    });
+  };
+
+  getOrdersByWallet = () => {};
 }
 
 export { NftSwapV4 };

src/sdk/v4/orderbook.ts

@@ -3,40 +3,62 @@ import type { SignedNftOrderV4, SignedNftOrderV4Serialized } from './types';
 import { stringify } from '../../utils/query-string';
 import { serializeNftOrder } from './pure';
 
-const PRODUCTION_ORDERBOOK_API_ROOT_URL = 'https://api.trader.xyz';
+export const ORDERBOOK_API_ROOT_URL_PRODUCTION = 'https://api.trader.xyz';
 
 interface OrderbookRequestOptions {
   rootUrl: string;
 }
 
 interface PostOrderRequestPayload {
   order: SignedNftOrderV4Serialized;
-  chainId: number;
+  chainId: string;
   metadata?: Record<string, string>;
 }
 
+export interface OrderDataPayload {
+  erc20Token: string;
+  erc20TokenAmount: string;
+  nftToken: string;
+  nftTokenId: string;
+  nftTokenAmount: string;
+  nftType: string;
+  sellOrBuyNft: 'buy' | 'sell';
+  chainId: string;
+  order: SignedNftOrderV4Serialized;
+  metadata: Record<string, string> | null;
+}
+
+type PostOrderResponsePayload = OrderDataPayload;
+
+interface SearchOrdersResponsePayload {
+  orders: Array<OrderDataPayload>;
+}
+
 const postOrderToOrderbook = async (
   signedOrder: SignedNftOrderV4,
-  chainId: number,
+  chainId: string,
   metadata: Record<string, string> = {},
   requestOptions?: Partial<OrderbookRequestOptions>,
   fetchFn: typeof unfetch = unfetch
-) => {
+): Promise<PostOrderResponsePayload> => {
   const payload: PostOrderRequestPayload = {
     order: serializeNftOrder(signedOrder),
     chainId,
     metadata,
   };
 
-  let rootUrl = requestOptions?.rootUrl ?? PRODUCTION_ORDERBOOK_API_ROOT_URL;
+  let rootUrl = requestOptions?.rootUrl ?? ORDERBOOK_API_ROOT_URL_PRODUCTION;
 
-  const orderPostResult = await fetchFn(`${rootUrl}/orderbook/order`, {
-    method: 'post',
-    headers: {
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify(payload),
-  })
+  const orderPostResult: PostOrderResponsePayload = await fetchFn(
+    `${rootUrl}/orderbook/order`,
+    {
+      method: 'post',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify(payload),
+    }
+  )
     .then(async (res) => {
       if (!res.ok) {
         throw await res.json();
@@ -62,10 +84,10 @@ const searchOrderbook = async (
   filters: Partial<SearchParams>,
   requestOptions?: Partial<OrderbookRequestOptions>,
   fetchFn: typeof unfetch = unfetch
-) => {
+): Promise<SearchOrdersResponsePayload> => {
   const stringifiedQueryParams = stringify(filters);
 
-  let rootUrl = requestOptions?.rootUrl ?? PRODUCTION_ORDERBOOK_API_ROOT_URL;
+  let rootUrl = requestOptions?.rootUrl ?? ORDERBOOK_API_ROOT_URL_PRODUCTION;
 
   const findOrdersResult = await fetchFn(
     `${rootUrl}/orderbook/orders?${stringifiedQueryParams}`

test/v4/orderbook.test.ts

@@ -51,17 +51,13 @@ const MAKER_ASSET: SwappableAsset = {
 };
 
 describe('NFTSwapV4', () => {
-  it('v4 erc721 test', async () => {
+  it('v4 erc721 test with orderbook e2e', async () => {
     // NOTE(johnrjj) - Assumes USDC and DAI are already approved w/ the ExchangeProxy
 
     const v4Erc721Order = nftSwapperMaker.buildOrder(
       MAKER_ASSET,
       TAKER_ASSET,
       MAKER_WALLET_ADDRESS
-      // {
-      //   // Fix dates and salt so we have reproducible tests
-      //   expiration: new Date(3000, 10, 1),
-      // }
     );
 
     const signedOrder = await nftSwapperMaker.signOrder(v4Erc721Order);
@@ -70,76 +66,23 @@ describe('NFTSwapV4', () => {
 
     const createdOrder = await postOrderToOrderbook(
       signedOrder,
-      ROPSTEN_CHAIN_ID,
+      ROPSTEN_CHAIN_ID.toString(10),
       testMetadata
     );
 
-    expect(createdOrder.nonce).toEqual(v4Erc721Order.nonce);
+    expect(createdOrder.order.nonce).toEqual(v4Erc721Order.nonce);
 
-    const foundOrders = await searchOrderbook({
+    const orderSearch = await searchOrderbook({
       nonce: signedOrder.nonce.toString(),
     });
-    const maybeOrder = first(foundOrders);
+    const maybeOrder = first(orderSearch.orders);
 
     expect((maybeOrder as any).order.nonce).toEqual(signedOrder.nonce);
     expect((maybeOrder as any).metadata).toEqual(testMetadata);
 
     // const orderTofill = (maybeOrder as any).order as SignedNftOrderV4Serialized
-
     // const fillTx = await nftSwapperMaker.fillSignedOrder(orderTofill);
     // const txReceipt = await fillTx.wait();
-    // console.log('erc721 fill tx round trip with api', txReceipt.transactionHash);
-
-    // console.log('v4Erc721Order.nonce', v4Erc721Order.nonce.toString());
-
-    // const makerapprovalTx = await nftSwapperMaker.approveTokenOrNftByAsset(
-    //   MAKER_ASSET,
-    //   MAKER_WALLET_ADDRESS,
-    // )
-    // const makerApprovalTxHash = await (await makerapprovalTx.wait()).transactionHash
-    //   console.log('maker approval tx hash', makerApprovalTxHash)
-
-    // const takerApprovalTx = await nftSwapperMaker.approveTokenOrNftByAsset(
-    //   TAKER_ASSET,
-    //   MAKER_WALLET_ADDRESS,
-    // )
-
-    // const takerApprovalTxHash = await (await takerApprovalTx.wait()).transactionHash
-    // console.log('taker approval tx hash', takerApprovalTxHash)
-
-    // const signedOrder = await nftSwapperMaker.signOrder(v4Erc721Order);
-    // console.log('erc721 signatuee', signedOrder.signature);
-    // expect(signedOrder.signature.signatureType.toString()).toEqual('2');
-
-    // const fillTx = await nftSwapperMaker.fillSignedOrder(signedOrder);
-    // const txReceipt = await fillTx.wait();
-    // console.log('erc721 fill tx', txReceipt.transactionHash);
-
-    // expect(txReceipt.transactionHash).toBeTruthy();
-
-    // const normalizedOrder = normalizeOrder(order);
-    // const signedOrder = await nftSwapperMaker.signOrder(
-    //   normalizedOrder,
-    // );
-
-    // const normalizedSignedOrder = normalizeOrder(signedOrder);
-
-    // expect(normalizedSignedOrder.makerAddress.toLowerCase()).toBe(
-    //   MAKER_WALLET_ADDRESS.toLowerCase()
-    // );
-
-    // Uncomment to actually fill order
-    // const tx = await nftSwapperMaker.fillSignedOrder(signedOrder, undefined, {
-    //   gasPrice,
-    //   gasLimit: '500000',
-    //   // HACK(johnnrjj) - Rinkeby still has protocol fees, so we give it a little bit of ETH so its happy.
-    //   value: parseEther('0.01'),
-    // });
-
-    // const txReceipt = await tx.wait();
-    // expect(txReceipt.transactionHash).toBeTruthy();
-    // console.log(`Swapped on Rinkeby (txHAsh: ${txReceipt.transactionIndex})`);
+    // console.log(`Swapped on Ropsten (txHAsh: ${txReceipt.transactionIndex})`);
   });
 });
-
-// https://polygon-mumbai.g.alchemy.com/v2/VMBpFqjMYv2w-MWnc9df92w3R2TpMvSG