opensea-js 2.0.0-beta.2 → 2.0.0-beta.6

package/lib/seaport.d.ts

@@ -1,6 +1,7 @@
 import { BigNumber } from "bignumber.js";
 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";
 export declare class OpenSeaPort {
@@ -15,6 +16,7 @@ export declare class OpenSeaPort {
     private _wyvernProtocolReadOnly;
     private _wyvern2_2Protocol;
     private _wyvern2_2ProtocolReadOnly;
+    private _wyvernConfigOverride?;
     private _wyvernExchangeForOrderCreationPromise;
     private _emitter;
     private _wrappedNFTFactoryAddress;
@@ -583,16 +585,18 @@ export declare class OpenSeaPort {
      * Internal method exposed for dev flexibility.
      * @param accountAddress The user's wallet address
      * @param retries Optional number of retries to do
+     * @param wyvernProtocol optional wyvern protocol override
      */
-    _getProxy(accountAddress: string, retries?: number): Promise<string | null>;
+    _getProxy(accountAddress: string, retries?: number, wyvernProtocol?: WyvernProtocol): Promise<string | null>;
     /**
      * Initialize the proxy for a user's wallet.
      * Proxies are used to make trades on behalf of the order's maker so that
      *  trades can happen when the maker isn't online.
      * Internal method exposed for dev flexibility.
      * @param accountAddress The user's wallet address
+     * @param wyvernProtocol optional wyvern protocol override
      */
-    _initializeProxy(accountAddress: string): Promise<string>;
+    _initializeProxy(accountAddress: string, wyvernProtocol?: WyvernProtocol): Promise<string>;
     /**
      * For a fungible token to use in trades (like W-ETH), get the amount
      *  approved for use by the Wyvern transfer proxy.
@@ -711,11 +715,12 @@ export declare class OpenSeaPort {
      */
     approveOrder(order: UnsignedOrder): Promise<string>;
     _validateOrder(order: Order): Promise<boolean>;
-    _approveAll({ schemaNames, wyAssets, accountAddress, proxyAddress, }: {
+    _approveAll({ schemaNames, wyAssets, accountAddress, proxyAddress, wyvernProtocol, }: {
         schemaNames: WyvernSchemaName[];
         wyAssets: WyvernAsset[];
         accountAddress: string;
         proxyAddress?: string;
+        wyvernProtocol?: WyvernProtocol;
     }): Promise<(string | null)[]>;
     _buyOrderValidationAndApprovals({ order, counterOrder, accountAddress, }: {
         order: UnhashedOrder;
@@ -788,9 +793,11 @@ export declare class OpenSeaPort {
     /**
      * Generate the signature for authorizing an order
      * @param order Unsigned wyvern order
-     * @returns order signature in the form of v, r, s
+     * @returns order signature in the form of v, r, s, also an optional nonce
      */
-    authorizeOrder(order: UnsignedOrder): Promise<ECSignature | null>;
+    authorizeOrder(order: UnsignedOrder): Promise<(ECSignature & {
+        nonce?: number;
+    }) | null>;
     private _getSchema;
     private _dispatch;
     /**
@@ -801,6 +808,7 @@ export declare class OpenSeaPort {
     private _confirmTransaction;
     private _pollCallbackForConfirmation;
     private _getWyvernProtocolForOrder;
+    private _getWyvernTokenTransferProxyAddressForOrder;
     /**
      * Returns whether or not an authenticated proxy is revoked for a specific account address
      * @param accountAddress

package/lib/seaport.js

@@ -113,6 +113,7 @@ var OpenSeaPort = /** @class */ (function () {
         // API config
         apiConfig.networkName = apiConfig.networkName || types_1.Network.Main;
         this.api = new api_1.OpenSeaAPI(apiConfig);
+        this._wyvernConfigOverride = apiConfig.wyvernConfig;
         this._networkName = apiConfig.networkName;
         var readonlyProvider = new web3_1.default.providers.HttpProvider("".concat(this.api.apiBaseUrl, "/").concat(constants_1.RPC_URL_PATH));
         var useReadOnlyProvider = (_b = apiConfig.useReadOnlyProvider) !== null && _b !== void 0 ? _b : true;
@@ -124,20 +125,14 @@ var OpenSeaPort = /** @class */ (function () {
         // WyvernJS config
         this._wyvernProtocol = new wyvern_js_1.WyvernProtocol(provider, __assign({ network: this._networkName }, apiConfig.wyvernConfig));
         // Wyvern2.2JS config
-        this._wyvern2_2Protocol = new wyvern_js_1.WyvernProtocol(provider, {
-            network: this._networkName,
-            wyvernExchangeContractAddress: utils_1.wyvern2_2AddressByNetwork[this._networkName],
-        });
+        this._wyvern2_2Protocol = new wyvern_js_1.WyvernProtocol(provider, __assign({ network: this._networkName }, utils_1.wyvern2_2ConfigByNetwork[this._networkName]));
         // WyvernJS config for readonly (optimization for infura calls)
         this._wyvernProtocolReadOnly = useReadOnlyProvider
             ? new wyvern_js_1.WyvernProtocol(readonlyProvider, __assign({ network: this._networkName }, apiConfig.wyvernConfig))
             : this._wyvernProtocol;
         // Wyvern2.2 JS config for readonly (optimization for infura calls)
         this._wyvern2_2ProtocolReadOnly = useReadOnlyProvider
-            ? new wyvern_js_1.WyvernProtocol(readonlyProvider, {
-                network: this._networkName,
-                wyvernExchangeContractAddress: utils_1.wyvern2_2AddressByNetwork[this._networkName],
-            })
+            ? new wyvern_js_1.WyvernProtocol(readonlyProvider, __assign({ network: this._networkName }, utils_1.wyvern2_2ConfigByNetwork[this._networkName]))
             : this._wyvern2_2Protocol;
         // WrappedNFTLiquidationProxy Config
         this._wrappedNFTFactoryAddress =
@@ -2049,14 +2044,16 @@ var OpenSeaPort = /** @class */ (function () {
      * Internal method exposed for dev flexibility.
      * @param accountAddress The user's wallet address
      * @param retries Optional number of retries to do
+     * @param wyvernProtocol optional wyvern protocol override
      */
-    OpenSeaPort.prototype._getProxy = function (accountAddress, retries) {
+    OpenSeaPort.prototype._getProxy = function (accountAddress, retries, wyvernProtocol) {
         if (retries === void 0) { retries = 0; }
+        if (wyvernProtocol === void 0) { wyvernProtocol = this._wyvernProtocolReadOnly; }
         return __awaiter(this, void 0, void 0, function () {
             var proxyAddress;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, this._wyvernProtocolReadOnly.wyvernProxyRegistry.proxies.callAsync(accountAddress)];
+                    case 0: return [4 /*yield*/, wyvernProtocol.wyvernProxyRegistry.proxies.callAsync(accountAddress)];
                     case 1:
                         proxyAddress = _b.sent();
                         if (proxyAddress == "0x") {
@@ -2083,8 +2080,10 @@ var OpenSeaPort = /** @class */ (function () {
      *  trades can happen when the maker isn't online.
      * Internal method exposed for dev flexibility.
      * @param accountAddress The user's wallet address
+     * @param wyvernProtocol optional wyvern protocol override
      */
-    OpenSeaPort.prototype._initializeProxy = function (accountAddress) {
+    OpenSeaPort.prototype._initializeProxy = function (accountAddress, wyvernProtocol) {
+        if (wyvernProtocol === void 0) { wyvernProtocol = this._wyvernProtocol; }
         return __awaiter(this, void 0, void 0, function () {
             var txnData, gasEstimate, transactionHash, proxyAddress;
             var _this = this;
@@ -2094,17 +2093,17 @@ var OpenSeaPort = /** @class */ (function () {
                         this._dispatch(types_1.EventType.InitializeAccount, { accountAddress: accountAddress });
                         this.logger("Initializing proxy for account: ".concat(accountAddress));
                         txnData = { from: accountAddress };
-                        return [4 /*yield*/, this._wyvernProtocolReadOnly.wyvernProxyRegistry.registerProxy.estimateGasAsync(txnData)];
+                        return [4 /*yield*/, wyvernProtocol.wyvernProxyRegistry.registerProxy.estimateGasAsync(txnData)];
                     case 1:
                         gasEstimate = _b.sent();
-                        return [4 /*yield*/, this._wyvernProtocol.wyvernProxyRegistry.registerProxy.sendTransactionAsync(__assign(__assign({}, txnData), { gas: this._correctGasAmount(gasEstimate) }))];
+                        return [4 /*yield*/, wyvernProtocol.wyvernProxyRegistry.registerProxy.sendTransactionAsync(__assign(__assign({}, txnData), { gas: this._correctGasAmount(gasEstimate) }))];
                     case 2:
                         transactionHash = _b.sent();
                         return [4 /*yield*/, this._confirmTransaction(transactionHash, types_1.EventType.InitializeAccount, "Initializing proxy for account", function () { return __awaiter(_this, void 0, void 0, function () {
                                 var polledProxy;
                                 return __generator(this, function (_b) {
                                     switch (_b.label) {
-                                        case 0: return [4 /*yield*/, this._getProxy(accountAddress)];
+                                        case 0: return [4 /*yield*/, this._getProxy(accountAddress, 0, wyvernProtocol)];
                                         case 1:
                                             polledProxy = _b.sent();
                                             return [2 /*return*/, !!polledProxy];
@@ -2113,7 +2112,7 @@ var OpenSeaPort = /** @class */ (function () {
                             }); })];
                     case 3:
                         _b.sent();
-                        return [4 /*yield*/, this._getProxy(accountAddress, 10)];
+                        return [4 /*yield*/, this._getProxy(accountAddress, 10, wyvernProtocol)];
                     case 4:
                         proxyAddress = _b.sent();
                         if (!proxyAddress) {
@@ -2217,7 +2216,9 @@ var OpenSeaPort = /** @class */ (function () {
                                 side: types_1.OrderSide.Buy,
                                 saleKind: types_1.SaleKind.FixedPrice,
                                 target: target,
-                                howToCall: types_1.HowToCall.DelegateCall,
+                                howToCall: target === utils_1.merkleValidatorByNetwork[this._networkName]
+                                    ? types_1.HowToCall.DelegateCall
+                                    : types_1.HowToCall.Call,
                                 calldata: calldata,
                                 replacementPattern: replacementPattern,
                                 staticTarget: staticTarget,
@@ -2720,7 +2721,7 @@ var OpenSeaPort = /** @class */ (function () {
     OpenSeaPort.prototype._sellOrderValidationAndApprovals = function (_b) {
         var order = _b.order, accountAddress = _b.accountAddress;
         return __awaiter(this, void 0, void 0, function () {
-            var wyAssets, schemaNames, tokenAddress, minimumAmount, wyvernProtocolReadOnly, sellValid;
+            var wyAssets, schemaNames, tokenAddress, wyvernProtocol, minimumAmount, tokenTransferProxyAddress, sellValid;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -2735,40 +2736,46 @@ var OpenSeaPort = /** @class */ (function () {
                                 ? [order.metadata.schema]
                                 : [];
                         tokenAddress = order.paymentToken;
-                        return [4 /*yield*/, this._approveAll({ schemaNames: schemaNames, wyAssets: wyAssets, accountAddress: accountAddress })];
+                        wyvernProtocol = this._getWyvernProtocolForOrder(order);
+                        return [4 /*yield*/, this._approveAll({
+                                schemaNames: schemaNames,
+                                wyAssets: wyAssets,
+                                accountAddress: accountAddress,
+                                wyvernProtocol: wyvernProtocol,
+                            })];
                     case 1:
                         _c.sent();
                         if (!(tokenAddress != constants_1.NULL_ADDRESS)) return [3 /*break*/, 3];
                         minimumAmount = (0, utils_1.makeBigNumber)(order.basePrice);
+                        tokenTransferProxyAddress = this._getWyvernTokenTransferProxyAddressForOrder(order);
                         return [4 /*yield*/, this.approveFungibleToken({
                                 accountAddress: accountAddress,
                                 tokenAddress: tokenAddress,
                                 minimumAmount: minimumAmount,
+                                proxyAddress: tokenTransferProxyAddress,
                             })];
                     case 2:
                         _c.sent();
                         _c.label = 3;
-                    case 3:
-                        wyvernProtocolReadOnly = this._getWyvernProtocolForOrder(order);
-                        return [4 /*yield*/, wyvernProtocolReadOnly.wyvernExchange.validateOrderParameters_.callAsync([
-                                order.exchange,
-                                order.maker,
-                                order.taker,
-                                order.feeRecipient,
-                                order.target,
-                                order.staticTarget,
-                                order.paymentToken,
-                            ], [
-                                order.makerRelayerFee,
-                                order.takerRelayerFee,
-                                order.makerProtocolFee,
-                                order.takerProtocolFee,
-                                order.basePrice,
-                                order.extra,
-                                order.listingTime,
-                                order.expirationTime,
-                                order.salt,
-                            ], order.feeMethod, order.side, order.saleKind, order.howToCall, order.calldata, order.replacementPattern, order.staticExtradata, { from: accountAddress })];
+                    case 3: return [4 /*yield*/, wyvernProtocol.wyvernExchange.validateOrderParameters_.callAsync([
+                            order.exchange,
+                            order.maker,
+                            order.taker,
+                            order.feeRecipient,
+                            order.target,
+                            order.staticTarget,
+                            order.paymentToken,
+                        ], [
+                            order.makerRelayerFee,
+                            order.takerRelayerFee,
+                            order.makerProtocolFee,
+                            order.takerProtocolFee,
+                            order.basePrice,
+                            order.extra,
+                            order.listingTime,
+                            order.expirationTime,
+                            order.salt,
+                        ], order.feeMethod, order.side, order.saleKind, order.howToCall, order.calldata, order.replacementPattern, order.staticExtradata, { from: accountAddress })];
                     case 4:
                         sellValid = _c.sent();
                         if (!sellValid) {
@@ -2870,27 +2877,28 @@ var OpenSeaPort = /** @class */ (function () {
         });
     };
     OpenSeaPort.prototype._approveAll = function (_b) {
-        var schemaNames = _b.schemaNames, wyAssets = _b.wyAssets, accountAddress = _b.accountAddress, proxyAddress = _b.proxyAddress;
+        var schemaNames = _b.schemaNames, wyAssets = _b.wyAssets, accountAddress = _b.accountAddress, proxyAddress = _b.proxyAddress, _c = _b.wyvernProtocol, wyvernProtocol = _c === void 0 ? this._wyvernProtocol : _c;
         return __awaiter(this, void 0, void 0, function () {
-            var _c, contractsWithApproveAll;
+            var _d, contractsWithApproveAll;
             var _this = this;
-            return __generator(this, function (_d) {
-                switch (_d.label) {
+            return __generator(this, function (_e) {
+                switch (_e.label) {
                     case 0:
-                        _c = proxyAddress;
-                        if (_c) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this._getProxy(accountAddress)];
+                        _d = proxyAddress;
+                        if (_d) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this._getProxy(accountAddress, 0, wyvernProtocol)];
                     case 1:
-                        _c = (_d.sent());
-                        _d.label = 2;
+                        _d = (_e.sent());
+                        _e.label = 2;
                     case 2:
                         proxyAddress =
-                            _c || undefined;
+                            _d ||
+                                undefined;
                         if (!!proxyAddress) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this._initializeProxy(accountAddress)];
+                        return [4 /*yield*/, this._initializeProxy(accountAddress, wyvernProtocol)];
                     case 3:
-                        proxyAddress = _d.sent();
-                        _d.label = 4;
+                        proxyAddress = _e.sent();
+                        _e.label = 4;
                     case 4:
                         contractsWithApproveAll = new Set();
                         return [2 /*return*/, Promise.all(wyAssets.map(function (wyAsset, i) { return __awaiter(_this, void 0, void 0, function () {
@@ -2968,7 +2976,7 @@ var OpenSeaPort = /** @class */ (function () {
     OpenSeaPort.prototype._buyOrderValidationAndApprovals = function (_b) {
         var order = _b.order, counterOrder = _b.counterOrder, accountAddress = _b.accountAddress;
         return __awaiter(this, void 0, void 0, function () {
-            var tokenAddress, balance, minimumAmount, wyvernProtocolReadOnly, buyValid;
+            var tokenAddress, balance, minimumAmount, tokenTransferProxyAddress, wyvernProtocolReadOnly, buyValid;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -2997,12 +3005,14 @@ var OpenSeaPort = /** @class */ (function () {
                                 throw new Error("Insufficient balance.");
                             }
                         }
+                        tokenTransferProxyAddress = this._getWyvernTokenTransferProxyAddressForOrder(order);
                         // Check token approval
                         // This can be done at a higher level to show UI
                         return [4 /*yield*/, this.approveFungibleToken({
                                 accountAddress: accountAddress,
                                 tokenAddress: tokenAddress,
                                 minimumAmount: minimumAmount,
+                                proxyAddress: tokenTransferProxyAddress,
                             })];
                     case 4:
                         // Check token approval
@@ -3475,11 +3485,11 @@ var OpenSeaPort = /** @class */ (function () {
     /**
      * Generate the signature for authorizing an order
      * @param order Unsigned wyvern order
-     * @returns order signature in the form of v, r, s
+     * @returns order signature in the form of v, r, s, also an optional nonce
      */
     OpenSeaPort.prototype.authorizeOrder = function (order) {
         return __awaiter(this, void 0, void 0, function () {
-            var signerAddress, message_1, signerOrderNonce, orderForSigning, message, error_15;
+            var signerAddress, message_1, signerOrderNonce, orderForSigning, message, ecSignature, error_15;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -3491,7 +3501,9 @@ var OpenSeaPort = /** @class */ (function () {
                         _b.label = 1;
                     case 1:
                         _b.trys.push([1, 6, , 7]);
-                        if (!(order.exchange === utils_1.wyvern2_2AddressByNetwork[this._networkName] &&
+                        if (!(order.exchange ===
+                            utils_1.wyvern2_2ConfigByNetwork[this._networkName]
+                                .wyvernExchangeContractAddress &&
                             order.hash)) return [3 /*break*/, 3];
                         message_1 = order.hash;
                         return [4 /*yield*/, (0, utils_1.personalSignAsync)(this.web3, message_1, signerAddress)];
@@ -3536,7 +3548,9 @@ var OpenSeaPort = /** @class */ (function () {
                             message: __assign(__assign({}, orderForSigning), { nonce: signerOrderNonce.toNumber() }),
                         });
                         return [4 /*yield*/, (0, utils_1.signTypedDataAsync)(this.web3, message, signerAddress)];
-                    case 5: return [2 /*return*/, _b.sent()];
+                    case 5:
+                        ecSignature = _b.sent();
+                        return [2 /*return*/, __assign(__assign({}, ecSignature), { nonce: signerOrderNonce.toNumber() })];
                     case 6:
                         error_15 = _b.sent();
                         this._dispatch(types_1.EventType.OrderDenied, {
@@ -3657,13 +3671,23 @@ var OpenSeaPort = /** @class */ (function () {
         });
     };
     OpenSeaPort.prototype._getWyvernProtocolForOrder = function (order, useReadOnly) {
-        if (order.exchange === utils_1.wyvern2_2AddressByNetwork[this._networkName]) {
+        if (order.exchange ===
+            utils_1.wyvern2_2ConfigByNetwork[this._networkName].wyvernExchangeContractAddress) {
             return useReadOnly
                 ? this._wyvern2_2ProtocolReadOnly
                 : this._wyvern2_2Protocol;
         }
         return useReadOnly ? this._wyvernProtocolReadOnly : this._wyvernProtocol;
     };
+    OpenSeaPort.prototype._getWyvernTokenTransferProxyAddressForOrder = function (order) {
+        var _b;
+        return ((order.exchange ===
+            utils_1.wyvern2_2ConfigByNetwork[this._networkName].wyvernExchangeContractAddress
+            ? utils_1.wyvern2_2ConfigByNetwork[this._networkName]
+                .wyvernTokenTransferProxyContractAddress
+            : (_b = this._wyvernConfigOverride) === null || _b === void 0 ? void 0 : _b.wyvernTokenTransferProxyContractAddress) ||
+            wyvern_js_1.WyvernProtocol.getTokenTransferProxyAddress(this._networkName));
+    };
     /**
      * Returns whether or not an authenticated proxy is revoked for a specific account address
      * @param accountAddress