EnglishAuction interface
Represents a new marketplace english-auction.
Signature:
export interface EnglishAuction
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| asset | NFTMetadata | The asset being auctioned. | |
| assetContractAddress | string | The address of the asset being auctioned. | |
| bidBufferBps | number | This is a buffer in basis points e.g. x%. To be considered as a new winning bid, a bid must be at least x% greater than the current winning bid. | |
| buyoutBidAmount | string | The buyout price of the auction. | |
| buyoutCurrencyValue | CurrencyValue | The CurrencyValue of the buyout price. Useful for displaying the price information. | |
| creatorAddress | string | The address of the creator of auction. | |
| currencyContractAddress | string | The address of the currency to accept for the auction. | |
| endTimeInSeconds | number | The end time of the auction. | |
| id | string | The id of the auction | |
| minimumBidAmount | string | The minimum price that a bid must be in order to be accepted. | |
| minimumBidCurrencyValue | CurrencyValue | The CurrencyValue of the minimum bid amount. Useful for displaying the price information. | |
| quantity | string | The quantity of tokens to include in the auction. For ERC721s, this value should always be 1 (and will be forced internally regardless of what is passed here). | |
| startTimeInSeconds | number | The start time of the auction. | |
| status | Status | Whether the listing is CREATED, COMPLETED, or CANCELLED. | |
| timeBufferInSeconds | number | This is a buffer e.g. x seconds. If a new winning bid is made less than x seconds before expirationTimestamp, the expirationTimestamp is increased by x seconds. | |
| tokenId | string | The ID of the token to auction. |