typecheck tests, refactor tests, add quantity to orders

Author: alexanderatallah

lib/seaport.d.ts

@@ -191,7 +191,7 @@ export declare class OpenSeaPort {
     }): Promise<Order>;
     /**
      * Create a sell order to auction an asset.
-     * Will throw a 'You do not own this asset' error if the maker doesn't have the asset.
+     * Will throw a 'You do not own enough of this asset' error if the maker doesn't have the asset or not enough of it to sell the specific `quantity`.
      * If the user hasn't approved access to the token yet, this will emit `ApproveAllAssets` (or `ApproveAsset` if the contract doesn't support approve-all) before asking for approval.
      * @param param0 __namedParameters Object
      * @param tokenId DEPRECATED: Token ID. Use `asset` instead.

lib/seaport.js

@@ -176,6 +176,7 @@ export interface Asset {
     tokenAddress: string;
     version?: TokenStandardVersion;
     name?: string;
+    decimals?: number;
 }
 /**
  * Annotated asset contract with OpenSea metadata
@@ -288,6 +289,7 @@ export interface UnhashedOrder extends WyvernOrder {
     side: OrderSide;
     saleKind: SaleKind;
     howToCall: HowToCall;
+    quantity: BigNumber;
     makerReferrerFee: BigNumber;
     waitingForBestCounterOrder: boolean;
     metadata: {

lib/seaport.js.map

@@ -8,7 +8,7 @@
   ],
   "main": "lib/index.js",
   "scripts": {
-    "test": "./node_modules/.bin/mocha test/*.ts --require ts-node/register --timeout 15000",
+    "test": "./node_modules/.bin/mocha test/**/*.ts --require ts-node/register --timeout 15000",
     "lint": "tslint --project . 'src/**/*.ts' --fix",
     "build": "npm run lint && tsc",
     "docs": "npm run docsHtml",

lib/types.d.ts

@@ -1832,7 +1832,8 @@ export class OpenSeaPort {
 
     accountAddress = validateAndFormatWalletAddress(this.web3, accountAddress)
     const schema = this._getSchema(schemaName)
-    const wyAsset = getWyvernAsset(schema, asset, new BigNumber(quantity))
+    const quantityBN = WyvernProtocol.toBaseUnitAmount(makeBigNumber(quantity), asset.decimals || 0)
+    const wyAsset = getWyvernAsset(schema, asset, quantityBN)
 
     let makerRelayerFee
     let takerRelayerFee
@@ -1867,6 +1868,7 @@ export class OpenSeaPort {
       exchange: WyvernProtocol.getExchangeContractAddress(this._networkName),
       maker: accountAddress,
       taker,
+      quantity: quantityBN,
       makerRelayerFee,
       takerRelayerFee,
       makerProtocolFee: makeBigNumber(0),
@@ -1913,6 +1915,7 @@ export class OpenSeaPort {
 
     accountAddress = validateAndFormatWalletAddress(this.web3, accountAddress)
     const schema = this._getSchema(schemaName)
+    const quantityBN = WyvernProtocol.toBaseUnitAmount(makeBigNumber(quantity), asset.decimals || 0)
     const wyAsset = getWyvernAsset(schema, asset, new BigNumber(quantity))
     const isPrivate = buyerAddress != NULL_ADDRESS
     const { totalSellerFeeBPS,
@@ -1925,7 +1928,7 @@ export class OpenSeaPort {
       ? SaleKind.DutchAuction
       : SaleKind.FixedPrice
 
-    const { basePrice, extra } = await this._getPriceParameters(paymentTokenAddress, expirationTime, startAmount, endAmount, waitForHighestBid)
+    const { basePrice, extra,  } = await this._getPriceParameters(paymentTokenAddress, expirationTime, startAmount, endAmount, waitForHighestBid)
     const times = this._getTimeParameters(expirationTime, waitForHighestBid)
     // Use buyer as the maker when it's an English auction, so Wyvern sets prices correctly
     const feeRecipient = waitForHighestBid
@@ -1945,6 +1948,7 @@ export class OpenSeaPort {
       exchange: WyvernProtocol.getExchangeContractAddress(this._networkName),
       maker: accountAddress,
       taker: buyerAddress,
+      quantity: quantityBN,
       makerRelayerFee,
       takerRelayerFee,
       makerProtocolFee: makeBigNumber(0),
@@ -2022,6 +2026,7 @@ export class OpenSeaPort {
       exchange: WyvernProtocol.getExchangeContractAddress(this._networkName),
       maker: accountAddress,
       taker: NULL_ADDRESS,
+      quantity: makeBigNumber(1),
       makerRelayerFee,
       takerRelayerFee,
       makerProtocolFee: makeBigNumber(0),
@@ -2102,6 +2107,7 @@ export class OpenSeaPort {
       exchange: WyvernProtocol.getExchangeContractAddress(this._networkName),
       maker: accountAddress,
       taker: buyerAddress,
+      quantity: makeBigNumber(1),
       makerRelayerFee: makeBigNumber(totalSellerFeeBPS),
       takerRelayerFee: makeBigNumber(totalBuyerFeeBPS),
       makerProtocolFee: makeBigNumber(0),
@@ -2176,6 +2182,7 @@ export class OpenSeaPort {
       exchange: order.exchange,
       maker: accountAddress,
       taker: order.maker,
+      quantity: order.quantity,
       makerRelayerFee: order.makerRelayerFee,
       takerRelayerFee: order.takerRelayerFee,
       makerProtocolFee: order.makerProtocolFee,

lib/utils.js

@@ -229,6 +229,8 @@ export interface Asset {
   version?: TokenStandardVersion,
   // Optional for ENS names
   name?: string,
+  // Optional for fungible items
+  decimals?: number
 }
 
 /**

lib/utils.js.map

@@ -11,8 +11,8 @@ import {
 import { ORDERBOOK_VERSION } from '../src/api'
 import { Order, OrderSide, OrderJSON } from '../src/types'
 import { orderToJSON } from '../src'
-import { mainApi, rinkebyApi, apiToTest, ALEX_ADDRESS, CK_RINKEBY_TOKEN_ID, CK_RINKEBY_ADDRESS, CK_RINKEBY_SELLER_FEE, MAINNET_API_KEY, CK_ADDRESS } from './constants'
-import { getOrderHash } from '../src/utils';
+import { mainApi, rinkebyApi, apiToTest, ALEX_ADDRESS, CK_RINKEBY_TOKEN_ID, CK_RINKEBY_ADDRESS, CK_RINKEBY_SELLER_FEE, RINKEBY_API_KEY, CK_ADDRESS } from './constants'
+import { getOrderHash } from '../src/utils'
 
 suite('api', () => {
 
@@ -35,20 +35,20 @@ suite('api', () => {
   })
 
   test('Includes API key in token request', async () => {
-    const oldLogger = apiToTest.logger
+    const oldLogger = rinkebyApi.logger
 
     const logPromise = new Promise((resolve, reject) => {
-      apiToTest.logger = log => {
+      rinkebyApi.logger = log => {
         try {
-          assert.include(log, `"X-API-KEY":"${MAINNET_API_KEY}"`)
+          assert.include(log, `"X-API-KEY":"${RINKEBY_API_KEY}"`)
           resolve()
         } catch (e) {
           reject(e)
         } finally {
-          apiToTest.logger = oldLogger
+          rinkebyApi.logger = oldLogger
         }
       }
-      apiToTest.getPaymentTokens({ symbol: "MANA" })
+      rinkebyApi.getPaymentTokens({ symbol: "WETH" })
     })
 
     await logPromise