IEnglishAuctions
The EnglishAuctions extension smart contract lets you sell NFTs (ERC-721 or ERC-1155) in an english auction.
Methods
bidInAuction
function bidInAuction(uint256 _auctionId, uint256 _bidAmount) external payable
Bid in an active auction.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | The ID of the auction to bid in. |
| _bidAmount | uint256 | The bid amount in the currency specified by the auction. |
cancelAuction
function cancelAuction(uint256 _auctionId) external nonpayable
Cancel an auction.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | The ID of the auction to cancel. |
collectAuctionPayout
function collectAuctionPayout(uint256 _auctionId) external nonpayable
Distribute the winning bid amount to the auction creator.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | The ID of an auction. |
collectAuctionTokens
function collectAuctionTokens(uint256 _auctionId) external nonpayable
Distribute the auctioned NFTs to the winning bidder.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | The ID of an auction. |
createAuction
function createAuction(IEnglishAuctions.AuctionParameters _params) external nonpayable returns (uint256 auctionId)
Parameters
| Name | Type | Description |
|---|
| _params | IEnglishAuctions.AuctionParameters | undefined |
Returns
| Name | Type | Description |
|---|
| auctionId | uint256 | undefined |
getAllAuctions
function getAllAuctions(uint256 _startId, uint256 _endId) external view returns (struct IEnglishAuctions.Auction[] auctions)
Returns all non-cancelled auctions.
Parameters
| Name | Type | Description |
|---|
| _startId | uint256 | undefined |
| _endId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| auctions | IEnglishAuctions.Auction[] | undefined |
getAllValidAuctions
function getAllValidAuctions(uint256 _startId, uint256 _endId) external view returns (struct IEnglishAuctions.Auction[] auctions)
Returns all active auctions.
Parameters
| Name | Type | Description |
|---|
| _startId | uint256 | undefined |
| _endId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| auctions | IEnglishAuctions.Auction[] | undefined |
getAuction
function getAuction(uint256 _auctionId) external view returns (struct IEnglishAuctions.Auction auction)
Returns the auction of the provided auction ID.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| auction | IEnglishAuctions.Auction | undefined |
getWinningBid
function getWinningBid(uint256 _auctionId) external view returns (address bidder, address currency, uint256 bidAmount)
Returns the winning bid of an active auction.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| bidder | address | undefined |
| currency | address | undefined |
| bidAmount | uint256 | undefined |
isAuctionExpired
function isAuctionExpired(uint256 _auctionId) external view returns (bool)
Returns whether an auction is active.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | undefined |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
isNewWinningBid
function isNewWinningBid(uint256 _auctionId, uint256 _bidAmount) external view returns (bool)
Returns whether a given bid amount would make for a winning bid in an auction.
Parameters
| Name | Type | Description |
|---|
| _auctionId | uint256 | The ID of an auction. |
| _bidAmount | uint256 | The bid amount to check. |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
Events
AuctionClosed
event AuctionClosed(uint256 indexed auctionId, address indexed assetContract, address indexed closer, uint256 tokenId, address auctionCreator, address winningBidder)
Emitted when an auction is closed.
Parameters
| Name | Type | Description |
|---|
auctionId indexed | uint256 | undefined |
assetContract indexed | address | undefined |
closer indexed | address | undefined |
| tokenId | uint256 | undefined |
| auctionCreator | address | undefined |
| winningBidder | address | undefined |
CancelledAuction
event CancelledAuction(address indexed auctionCreator, uint256 indexed auctionId)
Emitted when a auction is cancelled.
Parameters
| Name | Type | Description |
|---|
auctionCreator indexed | address | undefined |
auctionId indexed | uint256 | undefined |
NewAuction
event NewAuction(address indexed auctionCreator, uint256 indexed auctionId, address indexed assetContract, IEnglishAuctions.Auction auction)
Emitted when a new auction is created.
Parameters
| Name | Type | Description |
|---|
auctionCreator indexed | address | undefined |
auctionId indexed | uint256 | undefined |
assetContract indexed | address | undefined |
| auction | IEnglishAuctions.Auction | undefined |
NewBid
event NewBid(uint256 indexed auctionId, address indexed bidder, address indexed assetContract, uint256 bidAmount, IEnglishAuctions.Auction auction)
Emitted when a new bid is made in an auction.
Parameters
| Name | Type | Description |
|---|
auctionId indexed | uint256 | undefined |
bidder indexed | address | undefined |
assetContract indexed | address | undefined |
| bidAmount | uint256 | undefined |
| auction | IEnglishAuctions.Auction | undefined |