opensea-js 2.0.0 → 2.0.1-beta.2

package/README.md

@@ -44,6 +44,7 @@ Published on [GitHub](https://github.com/ProjectOpenSea/opensea-js) and [npm](ht
 - [Migrating to version 1.0](#migrating-to-version-10)
 - [Development Information](#development-information)
 - [Diagnosing Common Issues](#diagnosing-common-issues)
+- [Testing your branch locally](#testing-your-branch-locally)
 
 ## Synopsis
 
@@ -57,7 +58,7 @@ Happy seafaring! ⛵️
 
 ## Installation
 
-We recommend switching to Node.js version 8.11 to make sure common crypto dependencies work. Execute `nvm use`, if you have Node Version Manager.
+We recommend switching to Node.js version 16 to make sure common crypto dependencies work. Execute `nvm use`, if you have Node Version Manager.
 
 Then, in your project, run:
 
@@ -687,8 +688,6 @@ See the [Changelog](CHANGELOG.md).
 
 **Setup**
 
-[Node >= v8.11.2](https://nodejs.org/en/) required.
-
 Before any development, install the required NPM dependencies:
 
 ```bash

package/lib/seaport.d.ts

@@ -3,7 +3,7 @@ import { EventSubscription } from "fbemitter";
 import Web3 from "web3";
 import { WyvernProtocol } from "wyvern-js";
 import { OpenSeaAPI } from "./api";
-import { Asset, ComputedFees, ECSignature, EventData, EventType, FeeMethod, OpenSeaAPIConfig, OpenSeaAsset, OpenSeaFungibleToken, Order, OrderSide, PartialReadonlyContractAbi, UnhashedOrder, UnsignedOrder, WyvernAsset, WyvernSchemaName } from "./types";
+import { Asset, ComputedFees, ECSignature, EventData, EventType, FeeMethod, OpenSeaAPIConfig, OpenSeaAsset, OpenSeaFungibleToken, Order, OrderSide, PartialReadonlyContractAbi, UnhashedOrder, UnsignedOrder, WyvernAsset, WyvernAtomicMatchParameters, WyvernSchemaName } from "./types";
 export declare class OpenSeaPort {
     web3: Web3;
     web3ReadOnly: Web3;
@@ -321,6 +321,43 @@ export declare class OpenSeaPort {
         recipientAddress?: string;
         referrerAddress?: string;
     }): Promise<string>;
+    /**
+     * Returns estimated amount of gas required for Fullfilling the order.
+     * @param param0 __namedParamaters Object
+     * @param order The order to fulfill, a.k.a. "take"
+     * @param accountAddress The taker's wallet address
+     * @param recipientAddress The optional address to receive the order's item(s) or curriencies. If not specified, defaults to accountAddress.
+     * @param referrerAddress The optional address that referred the order
+     * @returns gasEstimation
+     */
+    getFulfillOrderGasEstimation({ order, accountAddress, recipientAddress, referrerAddress, }: {
+        order: Order;
+        accountAddress: string;
+        recipientAddress?: string;
+        referrerAddress?: string;
+    }): Promise<number>;
+    /**
+     * Returns data required to fulfill the transaction.
+     * @param param0 __namedParamaters Object
+     * @param order The order to fulfill, a.k.a. "take"
+     * @param accountAddress The taker's wallet address
+     * @param recipientAddress The optional address to receive the order's item(s) or curriencies. If not specified, defaults to accountAddress.
+     * @param referrerAddress The optional address that referred the order
+     * @returns gasEstimation
+     */
+    getFulfillOrderArgs({ order, accountAddress, recipientAddress, referrerAddress, }: {
+        order: Order;
+        accountAddress: string;
+        recipientAddress?: string;
+        referrerAddress?: string;
+    }): Promise<{
+        args: WyvernAtomicMatchParameters;
+        txnData: {
+            from: string;
+            value?: BigNumber;
+            gas?: number;
+        };
+    }>;
     /**
      * Cancel an order on-chain, preventing it from ever being fulfilled.
      * @param param0 __namedParameters Object
@@ -782,6 +819,9 @@ export declare class OpenSeaPort {
      */
     private _getPriceParameters;
     private _getMetadata;
+    private _validateOrderMatch;
+    private _getAtomicMatchCallArgs;
+    private _getAtomicMatchGasEstimation;
     private _atomicMatch;
     private _getRequiredAmountForTakingSellOrder;
     /**

package/lib/seaport.js

@@ -545,11 +545,11 @@ var OpenSeaPort = /** @class */ (function () {
                         return [4 /*yield*/, this._makeBundleBuyOrder({
                                 assets: assets,
                                 collection: collection,
-                                quantities: quantities,
+                                quantities: quantities !== null && quantities !== void 0 ? quantities : assets.map(function (_a) { return 1; }),
                                 accountAddress: accountAddress,
                                 startAmount: startAmount,
                                 expirationTime: expirationTime,
-                                paymentTokenAddress: paymentTokenAddress,
+                                paymentTokenAddress: paymentTokenAddress !== null && paymentTokenAddress !== void 0 ? paymentTokenAddress : WyvernSchemas.tokens[this._networkName].canonicalWrappedEther.address,
                                 extraBountyBasisPoints: 0,
                                 sellOrder: sellOrder,
                                 referrerAddress: referrerAddress,
@@ -617,7 +617,7 @@ var OpenSeaPort = /** @class */ (function () {
                                 accountAddress: accountAddress,
                                 startAmount: startAmount,
                                 expirationTime: expirationTime,
-                                paymentTokenAddress: paymentTokenAddress,
+                                paymentTokenAddress: paymentTokenAddress !== null && paymentTokenAddress !== void 0 ? paymentTokenAddress : WyvernSchemas.tokens[this._networkName].canonicalWrappedEther.address,
                                 extraBountyBasisPoints: 0,
                                 sellOrder: sellOrder,
                                 referrerAddress: referrerAddress,
@@ -981,6 +981,77 @@ var OpenSeaPort = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Returns estimated amount of gas required for Fullfilling the order.
+     * @param param0 __namedParamaters Object
+     * @param order The order to fulfill, a.k.a. "take"
+     * @param accountAddress The taker's wallet address
+     * @param recipientAddress The optional address to receive the order's item(s) or curriencies. If not specified, defaults to accountAddress.
+     * @param referrerAddress The optional address that referred the order
+     * @returns gasEstimation
+     */
+    OpenSeaPort.prototype.getFulfillOrderGasEstimation = function (_b) {
+        var order = _b.order, accountAddress = _b.accountAddress, recipientAddress = _b.recipientAddress, referrerAddress = _b.referrerAddress;
+        return __awaiter(this, void 0, void 0, function () {
+            var matchingOrder, _c, buy, sell, metadata, _d, args, txnData, wyvernProtocolReadOnly;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        matchingOrder = this._makeMatchingOrder({
+                            order: order,
+                            accountAddress: accountAddress,
+                            recipientAddress: recipientAddress || accountAddress,
+                        });
+                        _c = (0, utils_1.assignOrdersToSides)(order, matchingOrder), buy = _c.buy, sell = _c.sell;
+                        metadata = this._getMetadata(order, referrerAddress);
+                        return [4 /*yield*/, this._getAtomicMatchCallArgs({
+                                buy: buy,
+                                sell: sell,
+                                accountAddress: accountAddress,
+                                metadata: metadata,
+                            })];
+                    case 1:
+                        _d = _e.sent(), args = _d.args, txnData = _d.txnData;
+                        wyvernProtocolReadOnly = this._getWyvernProtocolForOrder(buy, true);
+                        return [2 /*return*/, this._getAtomicMatchGasEstimation({
+                                args: args,
+                                txnData: txnData,
+                                wyvernProtocolReadOnly: wyvernProtocolReadOnly,
+                            })];
+                }
+            });
+        });
+    };
+    /**
+     * Returns data required to fulfill the transaction.
+     * @param param0 __namedParamaters Object
+     * @param order The order to fulfill, a.k.a. "take"
+     * @param accountAddress The taker's wallet address
+     * @param recipientAddress The optional address to receive the order's item(s) or curriencies. If not specified, defaults to accountAddress.
+     * @param referrerAddress The optional address that referred the order
+     * @returns gasEstimation
+     */
+    OpenSeaPort.prototype.getFulfillOrderArgs = function (_b) {
+        var order = _b.order, accountAddress = _b.accountAddress, recipientAddress = _b.recipientAddress, referrerAddress = _b.referrerAddress;
+        return __awaiter(this, void 0, void 0, function () {
+            var matchingOrder, _c, buy, sell, metadata;
+            return __generator(this, function (_d) {
+                matchingOrder = this._makeMatchingOrder({
+                    order: order,
+                    accountAddress: accountAddress,
+                    recipientAddress: recipientAddress || accountAddress,
+                });
+                _c = (0, utils_1.assignOrdersToSides)(order, matchingOrder), buy = _c.buy, sell = _c.sell;
+                metadata = this._getMetadata(order, referrerAddress);
+                return [2 /*return*/, this._getAtomicMatchCallArgs({
+                        buy: buy,
+                        sell: sell,
+                        accountAddress: accountAddress,
+                        metadata: metadata,
+                    })];
+            });
+        });
+    };
     /**
      * Cancel an order on-chain, preventing it from ever being fulfilled.
      * @param param0 __namedParameters Object
@@ -3329,17 +3400,15 @@ var OpenSeaPort = /** @class */ (function () {
         }
         return undefined;
     };
-    OpenSeaPort.prototype._atomicMatch = function (_b) {
-        var buy = _b.buy, sell = _b.sell, accountAddress = _b.accountAddress, _c = _b.metadata, metadata = _c === void 0 ? constants_1.NULL_BLOCK_HASH : _c;
+    OpenSeaPort.prototype._validateOrderMatch = function (_b) {
+        var buy = _b.buy, sell = _b.sell, accountAddress = _b.accountAddress;
         return __awaiter(this, void 0, void 0, function () {
-            var value, shouldValidateBuy, shouldValidateSell, wyvernProtocol, wyvernProtocolReadOnly, txHash, txnData, args, gasEstimate, error_13, error_14;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+            var shouldValidateBuy, shouldValidateSell;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         shouldValidateBuy = true;
                         shouldValidateSell = true;
-                        wyvernProtocol = this._getWyvernProtocolForOrder(buy);
-                        wyvernProtocolReadOnly = this._getWyvernProtocolForOrder(buy, true);
                         if (!(sell.maker.toLowerCase() == accountAddress.toLowerCase())) return [3 /*break*/, 2];
                         // USER IS THE SELLER, only validate the buy order
                         return [4 /*yield*/, this._sellOrderValidationAndApprovals({
@@ -3348,11 +3417,11 @@ var OpenSeaPort = /** @class */ (function () {
                             })];
                     case 1:
                         // USER IS THE SELLER, only validate the buy order
-                        _d.sent();
+                        _c.sent();
                         shouldValidateSell = false;
-                        return [3 /*break*/, 6];
+                        return [3 /*break*/, 4];
                     case 2:
-                        if (!(buy.maker.toLowerCase() == accountAddress.toLowerCase())) return [3 /*break*/, 6];
+                        if (!(buy.maker.toLowerCase() == accountAddress.toLowerCase())) return [3 /*break*/, 4];
                         // USER IS THE BUYER, only validate the sell order
                         return [4 /*yield*/, this._buyOrderValidationAndApprovals({
                                 order: buy,
@@ -3361,30 +3430,43 @@ var OpenSeaPort = /** @class */ (function () {
                             })];
                     case 3:
                         // USER IS THE BUYER, only validate the sell order
-                        _d.sent();
+                        _c.sent();
                         shouldValidateBuy = false;
-                        if (!(buy.paymentToken == constants_1.NULL_ADDRESS)) return [3 /*break*/, 5];
-                        return [4 /*yield*/, this._getRequiredAmountForTakingSellOrder(sell)];
-                    case 4:
-                        value = _d.sent();
-                        _d.label = 5;
-                    case 5: return [3 /*break*/, 6];
-                    case 6: return [4 /*yield*/, this._validateMatch({
+                        return [3 /*break*/, 4];
+                    case 4: return [4 /*yield*/, this._validateMatch({
                             buy: buy,
                             sell: sell,
                             accountAddress: accountAddress,
                             shouldValidateBuy: shouldValidateBuy,
                             shouldValidateSell: shouldValidateSell,
                         })];
-                    case 7:
-                        _d.sent();
-                        this._dispatch(types_1.EventType.MatchOrders, {
-                            buy: buy,
-                            sell: sell,
-                            accountAddress: accountAddress,
-                            matchMetadata: metadata,
-                        });
-                        txnData = { from: accountAddress, value: value };
+                    case 5:
+                        _c.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    OpenSeaPort.prototype._getAtomicMatchCallArgs = function (_b) {
+        var buy = _b.buy, sell = _b.sell, accountAddress = _b.accountAddress, _c = _b.metadata, metadata = _c === void 0 ? constants_1.NULL_BLOCK_HASH : _c;
+        return __awaiter(this, void 0, void 0, function () {
+            var value, txnData, args;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        this._validateOrderMatch({ buy: buy, sell: sell, accountAddress: accountAddress });
+                        if (!(buy.maker.toLowerCase() == accountAddress.toLowerCase() &&
+                            buy.paymentToken == constants_1.NULL_ADDRESS)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this._getRequiredAmountForTakingSellOrder(sell)];
+                    case 1:
+                        // If using ETH to pay, set the value of the transaction to the current price
+                        value = _d.sent();
+                        _d.label = 2;
+                    case 2:
+                        txnData = {
+                            from: accountAddress,
+                            value: value,
+                        };
                         args = [
                             [
                                 buy.exchange,
@@ -3447,30 +3529,79 @@ var OpenSeaPort = /** @class */ (function () {
                                 metadata,
                             ],
                         ];
-                        _d.label = 8;
-                    case 8:
-                        _d.trys.push([8, 10, , 11]);
+                        return [2 /*return*/, {
+                                args: args,
+                                txnData: txnData,
+                            }];
+                }
+            });
+        });
+    };
+    OpenSeaPort.prototype._getAtomicMatchGasEstimation = function (_b) {
+        var args = _b.args, txnData = _b.txnData, wyvernProtocolReadOnly = _b.wyvernProtocolReadOnly;
+        return __awaiter(this, void 0, void 0, function () {
+            var gasEstimate, error_13;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        _c.trys.push([0, 2, , 3]);
                         return [4 /*yield*/, wyvernProtocolReadOnly.wyvernExchange.atomicMatch_.estimateGasAsync(args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], txnData)];
-                    case 9:
-                        gasEstimate = _d.sent();
-                        txnData.gas = this._correctGasAmount(gasEstimate);
-                        return [3 /*break*/, 11];
-                    case 10:
-                        error_13 = _d.sent();
+                    case 1:
+                        gasEstimate = _c.sent();
+                        return [2 /*return*/, this._correctGasAmount(gasEstimate)];
+                    case 2:
+                        error_13 = _c.sent();
                         console.error("Failed atomic match with args: ", args, error_13);
                         throw new Error("Oops, the Ethereum network rejected this transaction :( The OpenSea devs have been alerted, but this problem is typically due an item being locked or untransferrable. The exact error was \"".concat(error_13 instanceof Error
                             ? error_13.message.substr(0, debugging_1.MAX_ERROR_LENGTH)
                             : "unknown", "...\""));
-                    case 11:
-                        _d.trys.push([11, 13, , 14]);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    OpenSeaPort.prototype._atomicMatch = function (_b) {
+        var buy = _b.buy, sell = _b.sell, accountAddress = _b.accountAddress, _c = _b.metadata, metadata = _c === void 0 ? constants_1.NULL_BLOCK_HASH : _c;
+        return __awaiter(this, void 0, void 0, function () {
+            var wyvernProtocol, wyvernProtocolReadOnly, _d, args, txnData, _e, txHash, error_14;
+            return __generator(this, function (_f) {
+                switch (_f.label) {
+                    case 0:
+                        wyvernProtocol = this._getWyvernProtocolForOrder(buy);
+                        wyvernProtocolReadOnly = this._getWyvernProtocolForOrder(buy, true);
+                        return [4 /*yield*/, this._getAtomicMatchCallArgs({
+                                buy: buy,
+                                sell: sell,
+                                accountAddress: accountAddress,
+                                metadata: metadata,
+                            })];
+                    case 1:
+                        _d = _f.sent(), args = _d.args, txnData = _d.txnData;
+                        _e = txnData;
+                        return [4 /*yield*/, this._getAtomicMatchGasEstimation({
+                                args: args,
+                                txnData: txnData,
+                                wyvernProtocolReadOnly: wyvernProtocolReadOnly,
+                            })];
+                    case 2:
+                        _e.gas = _f.sent();
+                        this._dispatch(types_1.EventType.MatchOrders, {
+                            buy: buy,
+                            sell: sell,
+                            accountAddress: accountAddress,
+                            matchMetadata: metadata,
+                        });
+                        _f.label = 3;
+                    case 3:
+                        _f.trys.push([3, 5, , 6]);
                         this.logger("Fulfilling order with gas set to ".concat(txnData.gas));
                         return [4 /*yield*/, wyvernProtocol.wyvernExchange.atomicMatch_.sendTransactionAsync(args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], txnData)];
-                    case 12:
+                    case 4:
                         txHash =
-                            _d.sent();
-                        return [3 /*break*/, 14];
-                    case 13:
-                        error_14 = _d.sent();
+                            _f.sent();
+                        return [3 /*break*/, 6];
+                    case 5:
+                        error_14 = _f.sent();
                         console.error(error_14);
                         this._dispatch(types_1.EventType.TransactionDenied, {
                             error: error_14,
@@ -3482,7 +3613,7 @@ var OpenSeaPort = /** @class */ (function () {
                         throw new Error("Failed to authorize transaction: \"".concat(error_14 instanceof Error && error_14.message
                             ? error_14.message
                             : "user denied", "...\""));
-                    case 14: return [2 /*return*/, txHash];
+                    case 6: return [2 /*return*/, txHash];
                 }
             });
         });
@@ -3568,7 +3699,7 @@ var OpenSeaPort = /** @class */ (function () {
                             expirationTime: order.expirationTime.toString(),
                             salt: order.salt.toString(),
                         };
-                        message = JSON.stringify({
+                        message = {
                             types: constants_1.EIP_712_ORDER_TYPES,
                             domain: {
                                 name: constants_1.EIP_712_WYVERN_DOMAIN_NAME,
@@ -3578,7 +3709,7 @@ var OpenSeaPort = /** @class */ (function () {
                             },
                             primaryType: "Order",
                             message: __assign(__assign({}, orderForSigning), { nonce: signerOrderNonce.toNumber() }),
-                        });
+                        };
                         return [4 /*yield*/, (0, utils_1.signTypedDataAsync)(this.web3, message, signerAddress)];
                     case 5:
                         ecSignature = _b.sent();