opensea-js 2.0.1-beta.2 → 2.0.2-beta.1

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, WyvernAtomicMatchParameters, WyvernSchemaName } from "./types";
+import { Asset, ComputedFees, ECSignature, EventData, EventType, FeeMethod, OpenSeaAPIConfig, OpenSeaAsset, OpenSeaFungibleToken, Order, OrderSide, PartialReadonlyContractAbi, UnhashedOrder, UnsignedOrder, WyvernAsset, WyvernSchemaName } from "./types";
 export declare class OpenSeaPort {
     web3: Web3;
     web3ReadOnly: Web3;
@@ -150,7 +150,7 @@ export declare class OpenSeaPort {
      * @param quantities The quantity of each asset to sell. Defaults to 1 for each.
      * @param accountAddress Address of the maker's wallet
      * @param startAmount Value of the offer, in units of the payment token (or wrapped ETH if no payment token address specified)
-     * @param expirationTime Expiration time for the order, in seconds. An expiration time of 0 means "never expire"
+     * @param expirationTime Expiration time for the order, in seconds.
      * @param paymentTokenAddress Optional address for using an ERC-20 token in the order. If unspecified, defaults to W-ETH
      * @param sellOrder Optional sell order (like an English auction) to ensure fee and schema compatibility
      * @param referrerAddress The optional address that referred the order
@@ -177,7 +177,7 @@ export declare class OpenSeaPort {
      * @param accountAddress Address of the maker's wallet
      * @param startAmount Value of the offer, in units of the payment token (or wrapped ETH if no payment token address specified)
      * @param quantity The number of assets to bid for (if fungible or semi-fungible). Defaults to 1. In units, not base units, e.g. not wei.
-     * @param expirationTime Expiration time for the order, in seconds. An expiration time of 0 means "never expire"
+     * @param expirationTime Expiration time for the order, in seconds.
      * @param paymentTokenAddress Optional address for using an ERC-20 token in the order. If unspecified, defaults to W-ETH
      * @param sellOrder Optional sell order (like an English auction) to ensure fee and schema compatibility
      * @param referrerAddress The optional address that referred the order
@@ -205,7 +205,7 @@ export declare class OpenSeaPort {
      * @param endAmount Optional price of the asset at the end of its expiration time. Units are in the amount of a token above the token's decimal places (integer part). For example, for ether, expected units are in ETH, not wei.
      * @param quantity The number of assets to sell (if fungible or semi-fungible). Defaults to 1. In units, not base units, e.g. not wei.
      * @param listingTime Optional time when the order will become fulfillable, in UTC seconds. Undefined means it will start now.
-     * @param expirationTime Expiration time for the order, in UTC seconds. An expiration time of 0 means "never expire."
+     * @param expirationTime Expiration time for the order, in UTC seconds.
      * @param waitForHighestBid If set to true, this becomes an English auction that increases in price for every bid. The highest bid wins when the auction expires, as long as it's at least `startAmount`. `expirationTime` must be > 0.
      * @param englishAuctionReservePrice Optional price level, below which orders may be placed but will not be matched.  Orders below the reserve can be manually accepted but will not be automatically matched.
      * @param paymentTokenAddress Address of the ERC-20 token to accept in return. If undefined or null, uses Ether.
@@ -240,7 +240,7 @@ export declare class OpenSeaPort {
      * @param endAmount Optional price of the asset at the end of its expiration time. If not specified, will be set to `startAmount`. Units are in the amount of a token above the token's decimal places (integer part). For example, for ether, expected units are in ETH, not wei.
      * @param quantity The number of assets to sell at one time (if fungible or semi-fungible). Defaults to 1. In units, not base units, e.g. not wei.
      * @param listingTime Optional time when the order will become fulfillable, in UTC seconds. Undefined means it will start now.
-     * @param expirationTime Expiration time for the order, in seconds. An expiration time of 0 means "never expire."
+     * @param expirationTime Expiration time for the order, in seconds.
      * @param waitForHighestBid If set to true, this becomes an English auction that increases in price for every bid. The highest bid wins when the auction expires, as long as it's at least `startAmount`. `expirationTime` must be > 0.
      * @param paymentTokenAddress Address of the ERC-20 token to accept in return. If undefined or null, uses Ether.
      * @param extraBountyBasisPoints Optional basis points (1/100th of a percent) to reward someone for referring the fulfillment of each order
@@ -279,7 +279,7 @@ export declare class OpenSeaPort {
      * @param startAmount Price of the asset at the start of the auction, or minimum acceptable bid if it's an English auction.
      * @param endAmount Optional price of the asset at the end of its expiration time. If not specified, will be set to `startAmount`.
      * @param listingTime Optional time when the order will become fulfillable, in UTC seconds. Undefined means it will start now.
-     * @param expirationTime Expiration time for the order, in seconds. An expiration time of 0 means "never expire."
+     * @param expirationTime Expiration time for the order, in seconds.
      * @param waitForHighestBid If set to true, this becomes an English auction that increases in price for every bid. The highest bid wins when the auction expires, as long as it's at least `startAmount`. `expirationTime` must be > 0.
      * @param englishAuctionReservePrice Optional price level, below which orders may be placed but will not be matched.  Orders below the reserve can be manually accepted but will not be automatically matched.
      * @param paymentTokenAddress Address of the ERC-20 token to accept in return. If undefined or null, uses Ether.
@@ -321,43 +321,6 @@ 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
@@ -653,7 +616,7 @@ export declare class OpenSeaPort {
         quantity: number;
         accountAddress: string;
         startAmount: number;
-        expirationTime: number;
+        expirationTime?: number;
         paymentTokenAddress: string;
         extraBountyBasisPoints: number;
         sellOrder?: UnhashedOrder;
@@ -668,7 +631,7 @@ export declare class OpenSeaPort {
         waitForHighestBid: boolean;
         englishAuctionReservePrice?: number;
         listingTime?: number;
-        expirationTime: number;
+        expirationTime?: number;
         paymentTokenAddress: string;
         extraBountyBasisPoints: number;
         buyerAddress: string;
@@ -688,7 +651,7 @@ export declare class OpenSeaPort {
         quantities: number[];
         accountAddress: string;
         startAmount: number;
-        expirationTime: number;
+        expirationTime?: number;
         paymentTokenAddress: string;
         extraBountyBasisPoints: number;
         sellOrder?: UnhashedOrder;
@@ -707,7 +670,7 @@ export declare class OpenSeaPort {
         startAmount: number;
         endAmount?: number;
         listingTime?: number;
-        expirationTime: number;
+        expirationTime?: number;
         waitForHighestBid: boolean;
         englishAuctionReservePrice?: number;
         paymentTokenAddress: string;
@@ -819,9 +782,6 @@ export declare class OpenSeaPort {
      */
     private _getPriceParameters;
     private _getMetadata;
-    private _validateOrderMatch;
-    private _getAtomicMatchCallArgs;
-    private _getAtomicMatchGasEstimation;
     private _atomicMatch;
     private _getRequiredAmountForTakingSellOrder;
     /**