Skip to main content

BatchCatalogue

Git Source

Inherits: IBatchCatalogue, Catalogue

Contract that provides view and aggregation functions for batch auctions without having to know the specific auction module address

Functions

constructor

constructor(address auctionHouse_) Catalogue(auctionHouse_);

getNumBids

Get the number of bids for a lot

function getNumBids(uint96 lotId_) external view returns (uint256);

Parameters

NameTypeDescription
lotId_uint96The lot ID

Returns

NameTypeDescription
<none>uint256numBids The number of bids

getBidIds

Get the bid IDs from the given index

function getBidIds(
uint96 lotId_,
uint256 start_,
uint256 count_
) external view returns (uint64[] memory);

Parameters

NameTypeDescription
lotId_uint96The lot ID
start_uint256The index to start retrieving bid IDs from
count_uint256The number of bids to retrieve

Returns

NameTypeDescription
<none>uint64[]bidIds The bid IDs

getBidIdAtIndex

Get the bid ID at the given index

function getBidIdAtIndex(uint96 lotId_, uint256 index_) external view returns (uint64);

Parameters

NameTypeDescription
lotId_uint96The lot ID
index_uint256The index

Returns

NameTypeDescription
<none>uint64bidId The bid ID

getBidClaim

Get the claim data for a bid

function getBidClaim(
uint96 lotId_,
uint64 bidId_
) external view returns (IBatchAuction.BidClaim memory);

Parameters

NameTypeDescription
lotId_uint96The lot ID
bidId_uint64The bid ID

Returns

NameTypeDescription
<none>IBatchAuction.BidClaimbidClaim The bid claim data