Adds support to batch buy NFTs (#67)

* ADDS batch buy nfts
* ADDS tests for batch fill

Author: johnrjj

src/sdk/v4/NftSwapV4.ts

@@ -34,10 +34,15 @@ import {
 import type {
   AddressesForChainV4,
   ApprovalOverrides,
+  ERC721OrderStruct,
   FillOrderOverrides,
   NftOrderV4,
   NftOrderV4Serialized,
   OrderStructOptionsCommonStrict,
+  SignedERC1155OrderStruct,
+  SignedERC1155OrderStructSerialized,
+  SignedERC721OrderStruct,
+  SignedERC721OrderStructSerialized,
   SignedNftOrderV4,
   SigningOptionsV4,
   SwappableAssetV4,
@@ -63,6 +68,7 @@ import { DIRECTION_MAPPING, OrderStatusV4, TradeDirection } from './enums';
 import { CONTRACT_ORDER_VALIDATOR } from './properties';
 import { ETH_ADDRESS_AS_ERC20 } from './constants';
 import { ZERO_AMOUNT } from '../../utils/eth';
+import { arrayify } from '@ethersproject/bytes';
 
 export enum SupportedChainIdsV4 {
   Mainnet = 1,
@@ -276,6 +282,84 @@ class NftSwapV4 implements INftSwapV4 {
     throw new Error('unsupport order');
   };
 
+  /**
+   * Batch fill NFT sell orders
+   * Can be used by taker to fill multiple NFT sell orders atomically.
+   * E.g. A taker has a shopping cart full of NFTs to buy, can call this method to fill them all.
+   * Requires a valid signer to execute transaction
+   * @param signedOrders Signed 0x NFT sell orders
+   * @param revertIfIncomplete Revert if we don't fill _all_ orders (defaults to false)
+   * @param transacitonOverrides Ethers transaciton overrides
+   * @returns
+   */
+  batchBuyNfts = (
+    signedOrders: Array<SignedNftOrderV4>,
+    revertIfIncomplete: boolean = false,
+    transacitonOverrides?: PayableOverrides
+  ) => {
+    const allSellOrders = signedOrders.every((signedOrder) => {
+      if (signedOrder.direction === 0) {
+        return true;
+      }
+      return false;
+    });
+
+    invariant(
+      allSellOrders,
+      `batchBuyNfts: All orders must be of type sell order (order direction == 0)`
+    );
+
+    const allErc721 = signedOrders.every((signedOrder) => {
+      if ('erc721Token' in signedOrder) {
+        return true;
+      }
+      return false;
+    });
+
+    const allErc1155 = signedOrders.every((signedOrder) => {
+      if ('erc1155Token' in signedOrder) {
+        return true;
+      }
+      return false;
+    });
+
+    const eitherAllErc721OrErc1155Orders = allErc721 || allErc1155;
+
+    invariant(
+      eitherAllErc721OrErc1155Orders,
+      `Batch buy is only available for tokens of the same ERC type.`
+    );
+
+    if (allErc721) {
+      const erc721SignedOrders: SignedERC721OrderStruct[] =
+        signedOrders as SignedERC721OrderStruct[];
+      return this.exchangeProxy.batchBuyERC721s(
+        erc721SignedOrders,
+        erc721SignedOrders.map((so) => so.signature),
+        erc721SignedOrders.map((_) => '0x'),
+        revertIfIncomplete,
+        {
+          ...transacitonOverrides,
+        }
+      );
+    } else if (allErc1155) {
+      const erc1155SignedOrders: SignedERC1155OrderStruct[] =
+        signedOrders as SignedERC1155OrderStruct[];
+      return this.exchangeProxy.batchBuyERC1155s(
+        erc1155SignedOrders,
+        erc1155SignedOrders.map((so) => so.signature),
+        erc1155SignedOrders.map((so) => so.erc1155TokenAmount),
+        erc1155SignedOrders.map((_) => '0x'),
+        revertIfIncomplete,
+        {
+          ...transacitonOverrides,
+        }
+      );
+    } else {
+      throw Error('batchBuyNfts: Incompatible state');
+    }
+  };
+
   /**
    * Derives order hash from order (currently requires a provider to derive)
    * @param order A 0x v4 order (signed or unsigned)

test/v4/batch-erc721-fill.test.ts

@@ -0,0 +1,116 @@
+import { ethers } from 'ethers';
+import { NftSwapV4 } from '../../src/sdk/v4/NftSwapV4';
+
+import {
+  SignedERC721OrderStruct,
+  SwappableAssetV4,
+} from '../../src/sdk/v4/types';
+
+jest.setTimeout(120 * 1000);
+
+const MAKER_WALLET_ADDRESS = '0xabc23F70Df4F45dD3Df4EC6DA6827CB05853eC9b';
+const MAKER_PRIVATE_KEY =
+  'fc5db508b0a52da8fbcac3ab698088715595f8de9cccf2467d51952eec564ec9';
+// NOTE(johnrjj) - NEVER use these private keys for anything of value, testnets only!
+
+const DAI_TOKEN_ADDRESS_TESTNET = '0x31f42841c2db5173425b5223809cf3a38fede360';
+const TEST_NFT_CONTRACT_ADDRESS = '0xf5de760f2e916647fd766b4ad9e85ff943ce3a2b'; // https://ropsten.etherscan.io/token/0xf5de760f2e916647fd766b4ad9e85ff943ce3a2b?a=0xabc23F70Df4F45dD3Df4EC6DA6827CB05853eC9b
+
+const RPC_TESTNET =
+  'https://eth-ropsten.alchemyapi.io/v2/is1WqyAFM1nNFFx2aCozhTep7IxHVNGo';
+
+const MAKER_WALLET = new ethers.Wallet(MAKER_PRIVATE_KEY);
+// const TAKER_WALLET = new ethers.Wallet(TAKER_PRIVATE_KEY);
+
+const PROVIDER = new ethers.providers.StaticJsonRpcProvider(RPC_TESTNET);
+
+const MAKER_SIGNER = MAKER_WALLET.connect(PROVIDER);
+// const TAKER_PROVIDER = TAKER_WALLET.connect(PROVIDER);
+
+const ROPSTEN_CHAIN_ID = 3;
+
+const nftSwapperMaker = new NftSwapV4(
+  MAKER_SIGNER as any,
+  MAKER_SIGNER,
+  ROPSTEN_CHAIN_ID
+);
+// const nftSwapperTaker = new NftSwap(TAKER_PROVIDER as any, 4);
+
+const TAKER_ASSET: SwappableAssetV4 = {
+  type: 'ERC20',
+  tokenAddress: DAI_TOKEN_ADDRESS_TESTNET,
+  amount: '100000000000', // 1 USDC
+};
+const MAKER_ASSET_1: SwappableAssetV4 = {
+  type: 'ERC721',
+  tokenAddress: TEST_NFT_CONTRACT_ADDRESS,
+  tokenId: '11045',
+};
+
+const MAKER_ASSET_2: SwappableAssetV4 = {
+  type: 'ERC721',
+  tokenAddress: TEST_NFT_CONTRACT_ADDRESS,
+  tokenId: '171353',
+};
+
+describe('NFTSwapV4', () => {
+  it('v4 erc721 test', async () => {
+    // NOTE(johnrjj) - Assumes USDC and DAI are already approved w/ the ExchangeProxy
+
+    const v4Erc721Order_1 = nftSwapperMaker.buildOrder(
+      MAKER_ASSET_1,
+      TAKER_ASSET,
+      MAKER_WALLET_ADDRESS
+      // {
+      //   // Fix dates and salt so we have reproducible tests
+      //   expiration: new Date(3000, 10, 1),
+      // }
+    );
+
+    const v4Erc721Order_2 = nftSwapperMaker.buildOrder(
+      MAKER_ASSET_2,
+      TAKER_ASSET,
+      MAKER_WALLET_ADDRESS
+      // {
+      //   // Fix dates and salt so we have reproducible tests
+      //   expiration: new Date(3000, 10, 1),
+      // }
+    );
+
+    // console.log('v4Erc721Order.nonce', v4Erc721Order.nonce.toString());
+
+    // expect(v4Erc721Order.nonce.toString().includes('-')).toBeFalsy();
+
+    // 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_1 = await nftSwapperMaker.signOrder(v4Erc721Order_1);
+    const signedOrder_2 = await nftSwapperMaker.signOrder(v4Erc721Order_2);
+
+    // const fillTx = await nftSwapperMaker.batchBuyNfts([
+    //   signedOrder_1,
+    //   signedOrder_2,
+    // ]);
+
+    // const txReceipt = await fillTx.wait();
+    // console.log('erc721 batch fill fill tx', txReceipt.transactionHash);
+
+    // expect(txReceipt.transactionHash).toBeTruthy();
+
+    // console.log(
+    //   `Swapped batch nft fill on Ropsten (txHAsh: ${txReceipt.transactionIndex})`
+    // );
+  });
+});