IBatchCatalogue

Interface for the BatchCatalogue contract, which provides view functions for batch auctions

Functions

Get the number of bids for a lot

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

Parameters

Name	Type	Description
`lotId_`	`uint96`	The lot ID

Returns

Name	Type	Description
`numBids`	`uint256`	The number of bids

Get the bid IDs from the given index

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

Parameters

Name	Type	Description
`lotId_`	`uint96`	The lot ID
`start_`	`uint256`	The index to start retrieving bid IDs from
`count_`	`uint256`	The number of bids to retrieve

Returns

Name	Type	Description
`bidIds`	`uint64[]`	The bid IDs

Get the bid ID at the given index

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

Parameters

Name	Type	Description
`lotId_`	`uint96`	The lot ID
`index_`	`uint256`	The index

Returns

Name	Type	Description
`bidId`	`uint64`	The bid ID

Get the claim data for a bid

This provides information on the outcome of a bid, independent of the claim status

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

Parameters

Name	Type	Description
`lotId_`	`uint96`	The lot ID
`bidId_`	`uint64`	The bid ID

Returns

Name	Type	Description
`bidClaim`	`IBatchAuction.BidClaim`	The bid claim data