Getter for the contract parameters struct

function params() external view returns (SurplusAuctionHouseParams memory _sahParams);

Returns

Name	Type	Description
`_sahParams`	`SurplusAuctionHouseParams`	Auction house parameters struct

_params

Getter for the unpacked contract parameters struct

function _params()
  external
  view
  returns (
    uint256 _bidIncrease,
    uint256 _bidDuration,
    uint256 _totalAuctionLength,
    address _bidReceiver,
    uint256 _recyclingPercentage
  );

Returns

Name	Type	Description
`_bidIncrease`	`uint256`	Minimum bid increase compared to the last bid in order to take the new one in consideration [wad %]
`_bidDuration`	`uint256`	How long the auction lasts after a new bid is submitted [seconds]
`_totalAuctionLength`	`uint256`	Total length of the auction [seconds]
`_bidReceiver`	`address`	Receiver of protocol tokens
`_recyclingPercentage`	`uint256`	Percentage of protocol tokens to recycle [wad %]

terminateAuctionPrematurely

Terminate an auction prematurely.

function terminateAuctionPrematurely(uint256 _id) external;

Parameters

Name	Type	Description
`_id`	`uint256`	ID of the auction to settle/terminate

Events

TerminateAuctionPrematurely

Emitted when an auction is prematurely terminated

event TerminateAuctionPrematurely(
  uint256 indexed _id, uint256 _blockTimestamp, address _highBidder, uint256 _raisedAmount
);

Parameters

Name	Type	Description
`_id`	`uint256`	Id of the auction
`_blockTimestamp`	`uint256`	Time when the auction was terminated
`_highBidder`	`address`	Who won the auction
`_raisedAmount`	`uint256`	Amount of protocol tokens raised in the auction [rad]

Errors

SAH_NullProtTokenReceiver

Throws when trying to start an auction with non-zero recycling percentage and null bid receiver

error SAH_NullProtTokenReceiver();

Structs

SurplusAuctionHouseParams

struct SurplusAuctionHouseParams {
  uint256 bidIncrease;
  uint256 bidDuration;
  uint256 totalAuctionLength;
  address bidReceiver;
  uint256 recyclingPercentage;
}

ISurplusAuctionHouse

Functions

params