ISettlementSurplusAuctioneer
Inherits: IAuthorizable, IModifiable
Functions
lastSurplusTime
The last time when this contract triggered a surplus auction
function lastSurplusTime() external view returns (uint256 _lastSurplusTime);
accountingEngine
The address of the AccountingEngine
function accountingEngine() external view returns (IAccountingEngine _accountingEngine);
surplusAuctionHouse
The address of the SurplusAuctionHouse
function surplusAuctionHouse() external view returns (ISurplusAuctionHouse _surplusAuctionHouse);
safeEngine
The address of the SAFEEngine
function safeEngine() external view returns (ISAFEEngine _safeEngine);
auctionSurplus
Starts a new surplus auction
The contract reads surplus auction parameters from the AccountingEngine
function auctionSurplus() external returns (uint256 _id);
Returns
Name | Type | Description |
---|---|---|
_id | uint256 | The id of the started auction |
Events
AuctionSurplus
Emitted when the contract triggers a surplus auction
event AuctionSurplus(uint256 indexed _id, uint256 _lastSurplusAuctionTime, uint256 _coinBalance);
Parameters
Name | Type | Description |
---|---|---|
_id | uint256 | The id of the started auction |
_lastSurplusAuctionTime | uint256 | The timestamp of the surplus auction |
_coinBalance | uint256 | The remaining coin balance of the contract |
Errors
SSA_AccountingEngineStillEnabled
Throws if the AccountingEngine is still enabled
error SSA_AccountingEngineStillEnabled();
SSA_SurplusAuctionDelayNotPassed
Throws if the surplus auction delay has not passed
error SSA_SurplusAuctionDelayNotPassed();