ICatalogue
Interface for the Catalogue contract, which provides view functions for auctions
Functions
auctionHouse
Address of the IAuctionHouse contract
function auctionHouse() external view returns (address);
getRouting
Gets the routing information for a given lot ID
The function reverts if:
- The lot ID is invalid
function getRouting(uint96 lotId_) external view returns (IAuctionHouse.Routing memory);
Parameters
| Name | Type | Description |
|---|---|---|
lotId_ | uint96 | ID of the auction lot |
getFeeData
Gets the fee data for a given lot ID
The function reverts if:
- The lot ID is invalid
function getFeeData(uint96 lotId_) external view returns (IAuctionHouse.FeeData memory);
Parameters
| Name | Type | Description |
|---|---|---|
lotId_ | uint96 | ID of the auction lot |
isLive
Is the auction currently accepting bids or purchases?
Auctions that have been created, but not yet started will return false
function isLive(uint96 lotId_) external view returns (bool);
isUpcoming
Is the auction upcoming? (i.e. has not started yet)
function isUpcoming(uint96 lotId_) external view returns (bool);
hasEnded
Has the auction ended? (i.e. reached its conclusion and no more bids/purchases can be made)
function hasEnded(uint96 lotId_) external view returns (bool);
remainingCapacity
Capacity remaining for the auction. May be in quote or base tokens, depending on what is allowed for the auction type
function remainingCapacity(uint96 lotId_) external view returns (uint256);
getMaxLotId
ID of the last lot that was created
function getMaxLotId() external view returns (uint96);
getAuctionsBySeller
Returns array of lot IDs for auctions created by a specific seller within the provided range.
function getAuctionsBySeller(
address seller_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
seller_ | address | Address of the seller |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getAuctionsByRequestedCurator
Returns array of lot IDs for auctions that have requested a specific curator within the provided range. Lots are returned even if the curator has not approved the curation request.
function getAuctionsByRequestedCurator(
address curator_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
curator_ | address | Address of the curator |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getAuctionsByCurator
Returns array of lot IDs for auctions that are curated by a specific curator within the provided range. Lots are returned only if the curator has approved the curation request.
function getAuctionsByCurator(
address curator_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
curator_ | address | Address of the curator |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getAuctionsByQuoteToken
Returns array of lot IDs for auctions that have a specific quote token within the provided range.
function getAuctionsByQuoteToken(
address quoteToken_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
quoteToken_ | address | Address of the quote token |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getAuctionsByBaseToken
Returns array of lot IDs for auctions that have a specific base token within the provided range.
function getAuctionsByBaseToken(
address baseToken_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
baseToken_ | address | Address of the base token |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getAuctionsByModule
Returns array of lot IDs for auctions on a specific auction module within the provided range.
function getAuctionsByModule(
Veecode auctionReference_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
auctionReference_ | Veecode | Versioned keycode for the auction module |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getAuctionsByFormat
Returns array of lot IDs for auctions that have a specific type within the provided range.
function getAuctionsByFormat(
Keycode auctionFormat_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
auctionFormat_ | Keycode | Un-versioned keycode for the auction format |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getAuctionsByDerivative
Returns array of lot IDs for auctions that have a specific derivative within the provided range.
function getAuctionsByDerivative(
Veecode derivativeReference_,
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
derivativeReference_ | Veecode | Versioned keycode for the derivative module |
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getLiveAuctions
Returns array of lot IDs for auctions that are currently live for bidding/purchasing within the provided range.
function getLiveAuctions(
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
getUpcomingAuctions
Returns array of lot IDs for auctions that have not started yet within the provided range.
function getUpcomingAuctions(
uint96 startId_,
uint96 count_
) external view returns (uint96[] memory lotIds);
Parameters
| Name | Type | Description |
|---|---|---|
startId_ | uint96 | Lot ID to start from |
count_ | uint96 | Number of lots to process in this batch |
Returns
| Name | Type | Description |
|---|---|---|
lotIds | uint96[] | Array of lot IDs |
Errors
InvalidParams
error InvalidParams();