Skip to main content

EnglishAuction interface

Represents a new marketplace english-auction.

Signature:

export interface EnglishAuction

Properties

PropertyModifiersTypeDescription
assetNFTMetadataThe asset being auctioned.
assetContractAddressstringThe address of the asset being auctioned.
bidBufferBpsnumber

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.

buyoutBidAmountstringThe buyout price of the auction.
buyoutCurrencyValueCurrencyValueThe CurrencyValue of the buyout price. Useful for displaying the price information.
creatorAddressstringThe address of the creator of auction.
currencyContractAddressstringThe address of the currency to accept for the auction.
endTimeInSecondsnumberThe end time of the auction.
idstringThe id of the auction
minimumBidAmountstringThe minimum price that a bid must be in order to be accepted.
minimumBidCurrencyValueCurrencyValueThe CurrencyValue of the minimum bid amount. Useful for displaying the price information.
quantitystring

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).

startTimeInSecondsnumberThe start time of the auction.
statusStatusWhether the listing is CREATED, COMPLETED, or CANCELLED.
timeBufferInSecondsnumber

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.

tokenIdstringThe ID of the token to auction.