Seaport v1.2: large counters (#161)

* update counter to be Bignumberish, since in seaport v1.2 it is incremented by large amounts (rather than one by one)

* fix typo

Author: ryanio

src/__tests__/cancel.spec.ts

@@ -1,5 +1,6 @@
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
 import { expect } from "chai";
+import { BigNumber } from "ethers";
 import { parseEther } from "ethers/lib/utils";
 import { ethers } from "hardhat";
 import { ItemType } from "../constants";
@@ -76,8 +77,8 @@ describeWithFixture("As a user I want to cancel an order", (fixture) => {
     await expect(executeAllFulfillActionsOffChainOrder()).to.be.reverted;
     await expect(executeAllFulfillActionsOnChainOrder()).to.be.reverted;
 
-    expect(await seaport.getCounter(offerer.address)).to.equal(
-      offChainOrder.parameters.counter + 1
+    expect(await seaport.getCounter(offerer.address)).to.deep.equal(
+      BigNumber.from(offChainOrder.parameters.counter).add(1)
     );
   });
 

src/__tests__/create-bulk-orders.spec.ts

@@ -1,4 +1,5 @@
 import { expect } from "chai";
+import { BigNumber } from "ethers";
 import { ethers } from "hardhat";
 import { ItemType, MAX_INT, NO_CONDUIT, OrderType } from "../constants";
 import {
@@ -128,7 +129,7 @@ describeWithFixture(
             zone: ethers.constants.AddressZero,
             zoneHash: ethers.constants.HashZero,
             conduitKey: NO_CONDUIT,
-            counter: 0,
+            counter: BigNumber.from(0),
           },
           signature: order.signature,
         });

src/__tests__/create-order.spec.ts

@@ -6,6 +6,7 @@ import { ItemType, MAX_INT, NO_CONDUIT, OrderType } from "../constants";
 import { ApprovalAction, CreateOrderAction } from "../types";
 import { generateRandomSalt } from "../utils/order";
 import { describeWithFixture } from "./utils/setup";
+import { BigNumber } from "ethers";
 
 describeWithFixture("As a user I want to create an order", (fixture) => {
   it("should create the order after setting needed approvals", async () => {
@@ -103,7 +104,7 @@ describeWithFixture("As a user I want to create an order", (fixture) => {
         zone: ethers.constants.AddressZero,
         zoneHash: ethers.constants.HashZero,
         conduitKey: NO_CONDUIT,
-        counter: 0,
+        counter: BigNumber.from(0),
       },
       signature: order.signature,
     });
@@ -218,7 +219,7 @@ describeWithFixture("As a user I want to create an order", (fixture) => {
         zone: ethers.constants.AddressZero,
         zoneHash: ethers.constants.HashZero,
         conduitKey: NO_CONDUIT,
-        counter: 0,
+        counter: BigNumber.from(0),
       },
       signature: order.signature,
     });
@@ -382,7 +383,7 @@ describeWithFixture("As a user I want to create an order", (fixture) => {
         zone: ethers.constants.AddressZero,
         zoneHash: ethers.constants.HashZero,
         conduitKey: NO_CONDUIT,
-        counter: 0,
+        counter: BigNumber.from(0),
       },
       signature: order.signature,
     });
@@ -594,7 +595,7 @@ describeWithFixture("As a user I want to create an order", (fixture) => {
           zone: ethers.constants.AddressZero,
           zoneHash: ethers.constants.HashZero,
           conduitKey: NO_CONDUIT,
-          counter: 0,
+          counter: BigNumber.from(0),
         },
         signature: order.signature,
       });

src/__tests__/sign-order.spec.ts

@@ -58,7 +58,7 @@ describeWithFixture("As a user I want to sign an order", (fixture) => {
       endTime,
       zoneHash: ethers.constants.HashZero,
       conduitKey: NO_CONDUIT,
-      counter: counter.toNumber(),
+      counter,
     };
 
     const signature = await seaport.signOrder(orderComponents);

src/seaport.ts

@@ -636,10 +636,8 @@ export class Seaport {
    * @param offerer the offerer to get the counter of
    * @returns counter as a number
    */
-  public getCounter(offerer: string): Promise<number> {
-    return this.contract
-      .getCounter(offerer)
-      .then((counter) => counter.toNumber());
+  public getCounter(offerer: string): Promise<BigNumber> {
+    return this.contract.getCounter(offerer);
   }
 
   /**

src/types.ts

@@ -94,7 +94,7 @@ export type OrderParameters = {
   conduitKey: string;
 };
 
-export type OrderComponents = OrderParameters & { counter: number };
+export type OrderComponents = OrderParameters & { counter: BigNumberish };
 
 export type Order = {
   parameters: OrderParameters;
@@ -166,7 +166,7 @@ export type CreateOrderInput = {
   endTime?: string;
   offer: readonly CreateInputItem[];
   consideration: readonly ConsiderationInputItem[];
-  counter?: number;
+  counter?: BigNumberish;
   fees?: readonly Fee[];
   allowPartialFills?: boolean;
   restrictedByZone?: boolean;
@@ -325,7 +325,7 @@ export type SeaportContract = TypeChainSeaportContract & {
     ): Promise<BigNumber>;
   };
 
-  populateTranscation: TypeChainSeaportContract["populateTransaction"] & {
+  populateTransaction: TypeChainSeaportContract["populateTransaction"] & {
     matchOrders(
       orders: OrderStruct[],
       fulfillments: MatchOrdersFulfillment[],

src/utils/usecase.ts

@@ -25,11 +25,14 @@ export const executeAllActions = async <
 
   const finalAction = actions[actions.length - 1] as T;
 
-  return finalAction.type === "create"
-    ? await finalAction.createOrder()
-    : finalAction.type === "createBulk"
-    ? await finalAction.createBulkOrders()
-    : await finalAction.transactionMethods.transact();
+  switch (finalAction.type) {
+    case "create":
+      return finalAction.createOrder();
+    case "createBulk":
+      return finalAction.createBulkOrders();
+    default:
+      return finalAction.transactionMethods.transact();
+  }
 };
 
 const instanceOfOverrides = <