IFixedPriceSale

Git Source

Interface for fixed price sale (atomic) auctions

This contract does not inherit from IAtomicAuction or AtomicAuctionModule in order to avoid conflicts. Implementing contracts should inherit from both AtomicAuctionModule and this interface.

Functions

auctionData

Returns the AuctionData for a lot

function auctionData(uint96 lotId) external view returns (uint256 price, uint256 maxPayout);

Parameters

Name	Type	Description
lotId	uint96	The lot ID

Returns

Name	Type	Description
price	uint256	The fixed price of the lot
maxPayout	uint256	The maximum payout per purchase, in terms of the base token

Errors

Auction_InsufficientPayout

error Auction_InsufficientPayout();

Auction_PayoutGreaterThanMax

error Auction_PayoutGreaterThanMax();

Structs

AuctionDataParams

Parameters for a fixed price auction

struct AuctionDataParams {
    uint256 price;
    uint24 maxPayoutPercent;
}

Properties

Name	Type	Description
price	uint256	The fixed price of the lot
maxPayoutPercent	uint24	The maximum payout per purchase, as a percentage of the capacity (100% = 100e2 = 1e4)

PurchaseParams

Parameters to the purchase function

struct PurchaseParams {
    uint256 minAmountOut;
}

Properties

Name	Type	Description
minAmountOut	uint256	The minimum amount of the base token that must be received

AuctionData

Auction-specific data for a lot

struct AuctionData {
    uint256 price;
    uint256 maxPayout;
}

Properties

Name	Type	Description
price	uint256	The fixed price of the lot
maxPayout	uint256	The maximum payout per purchase, in terms of the base token