Fixed Discount Collateral Auction House
Auctioneer that tries to recapitalize the system by selling collateral at a discounted price
1. Summary
Fixed discount collateral auctions are similar to their English
counterpart in that they are used to preserve the overall system health by liquidating under-collateralized SAFEs and selling off collateral in exchange for system coins. This auction type automatically calculates an amount of collateral to send back to a bidder, taking into account the amount of system coins the bidder submits as well as the current system coin redemptionPrice
(and optionally its market price) and collateral market price.
2. Contract Variables & Functions
Variables
contractEnabled
- settlement flag (1
or0
).AUCTION_HOUSE_TYPE
- flag set tobytes32("COLLATERAL")
AUCTION_TYPE
- flag set tobytes32("FIXED_DISCOUNT")
.authorizedAccounts[usr: address]
- addresses allowed to callmodifyParameters()
anddisableContract()
.safeEngine
- storage of theSAFEEngine
's address.bids[id: uint]
- storage of all bids.collateralType
- id of the collateral type for which theCollateralAuctionHouse
is responsible.minimumBid
- minimum amount of system coins that must be submitted by each bidder.totalAuctionLength
- auction length (default:uint48(-1)
).auctionsStarted
- total auction count, used to track auctionid
s.lastReadRedemptionPrice
- the last read redemption price. Can (and most probably is) be different than the latestOracleRelayer._redemptionPrice
discount
- discount compared to the collateral market price; used when calculating the amount of collateral to send to a bidder.lowerCollateralMedianDeviation
- maxcollateralMedian
collateral price deviation (compared to theFSM
price) used when the median price is lower than thecollateralFSM
price and the contract needs to pick which one to useupperCollateralMedianDeviation
- maxcollateralMedian
collateral price deviation (compared to theFSM
price) used when the median price is higher than thecollateralFSM
price and the contract needs to pick which one to uselowerSystemCoinMedianDeviation
- maxsystemCoinOracle
price deviation (compared to theredemptionPrice
) used when the system coin'sredemptionPrice
price is higher than its market price and the contract needs to pick which one to useupperSystemCoinMedianDeviation
- maxsystemCoinOracle
price deviation (compared to theredemptionPrice
) used when the system coin'sredemptionPrice
price is lower than its market price and the contract needs to pick which one to useminSystemCoinMedianDeviation
- minimum deviation between the system coin's market and redemption prices that must be passed in order for the contract to use the deviated price instead of the redemption oneoracleRelayer
- address of theOracleRelayer
collateralFSM
- the collateral type'sFSM
addresscollateralMedian
- collateral type medianizer addresssystemCoinOracle
- market price oracle for the system coinliquidationEngine
- the address of theLiquidationEngine
RAD
- number with 45 decimals (e.g asafeEngine.coinBalance
)WAD
- number with 18 decimals (e.g a bid submitted when someone wants to buy collateral from an auction)RAY
- number with 27 decimals
Data Structures
Bid
- state of a specific auctionraisedAmount
- amount of system coins raised up until this pointsoldAmount
- amount of collateral sold up until this pointamountToSell
- quantity up for auction / collateral for saleamountToRaise
- total system coins wanted from the auctionauctionDeadline
- max auction durationforgoneCollateralReceiver
- address of the SAFE being auctionedauctionIncomeRecipient
- recipient of auction income / receives system coin income (this is theAccountingEngine
contract)
Modifiers
isAuthorized
- checks whether an address is part ofauthorizedAddresses
(and thus can call authed functions).
Functions
modifyParameters(bytes32 parameter
,uint256 data)
- update anuint256
parameter.modifyParameters(bytes32 parameter
,address data)
- update anaddress
parameter.addAuthorization(usr: address)
- add an address toauthorizedAddresses
.removeAuthorization(usr: address)
- remove an address fromauthorizedAddresses
.getCollateralMedianPrice() public view returns (priceFeed: uint256)
- get the collateral's median price fromcollateralMedian
getSystemCoinMarketPrice() public view returns (priceFeed: uint256)
- get the system coin's market price fromsystemCoinOracle
getFinalTokenPrices(systemCoinRedemptionPrice: uint256) public view returns (uint256
,uint256)
- get the collateral and system coin prices that can be currently used to determine the amount of collateral bought by biddersgetFinalBaseCollateralPrice(collateralFsmPriceFeedValue: uint256
,collateralMedianPriceFeedValue: uint256) public view returns (uint256)
- get the final collateral price (without the discount applied) that will be used to determine the amount of collateral bought by a bidgetDiscountedCollateralPrice(collateralFsmPriceFeedValue: bytes32
,collateralMedianPriceFeedValue: bytes32
,systemCoinPriceFeedValue: uint256
,customDiscount: uint256) public view returns (uint256)
- get the (discounted) collateral price using either theFSM
or median price for the collateral and the redemption/market price for the system coinstartAuction(forgoneCollateralReceiver: address
,auctionIncomeRecipient: address
,amountToRaise: uint256
,amountToSell: uint256
,initialBid: uint256 )
- function used byLiquidationEngine
to start an auction / put collateral up for auctiongetApproximateCollateralBought(id: uint256
,wad: uint256)
- get the amount of collateral that can be bought from a specific auction by biddingwad
and assuming that the latest system coinredemptionPrice
is equal tolastReadRedemptionPrice
getCollateralBought(id: uint256
,wad: uint256) returns (uint256
,uint256)
- get the amount of collateral that can be bought from a specific auction by biddingwad
amount of system coins (wherewad
will be scaled byRAY
to transfer the correct amount ofRAD
system coins fromsafeEngine.coinBalance
)buyCollateral(id: uint256
,wad: uint256)
- buy collateral from an auction and offerwad
amount of system coins in return (wherewad
is scaled byRAY
in order to transferRAD
amount of coins from the bidder'ssafeEngine.coinBalance
)settleAuction(id: uint256)
- settle an auction that has passed itsauctionDeadline
and return any unsold collateral to theforgoneCollateralReceiver
terminateAuctionPrematurely(id: uint256)
- normally used duringGlobalSettlement
to terminate an auction early and send unsold collateral to themsg.sender
as well as callLiquidationEngine
in order to subtractbids[auctionId].amountToRaise
fromLiquidationEngine.currentOnAuctionSystemCoins
bidAmount(id: uint256) public view returns (uint256)
- always returns zeroremainingAmountToSell(id: uint256) public view returns (uint256)
- return the remaining collateral amount to sell from a specific auctionforgoneCollateralReceiver(uint id) public view returns (address)
- returns theforgoneCollateralReceiver
for a specific auctionraisedAmount(id: uint256)
- returns the currently raised amount of system coins for a specific auction.amountToRaise(uint id) public view returns (uint256)
- returns the amount of system coins to raise for a specific auction
Events
AddAuthorization
- emitted when a new address becomes authorized. Contains:account
- the new authorized account
RemoveAuthorization
- emitted when an address is de-authorized. Contains:account
- the address that was de-authorized
StartAuction
- emitted whenstartAuction(address
,address
,uint256
,uint256
,uint256)
is successfully executed. Contains:id
- auction idauctionsStarted
- amount of auctions started up until nowamountToSell
- amount of collateral sold in the auctioninitialBid
- starting bid for the auction (usually zero).amountToRaise
- amount of system coins that should be raised by the auction.forgoneCollateralReceiver
- receiver of leftover collateral (usually the SAFE whose collateral was confiscated by theLiquidationEngine
).auctionIncomeRecipient
- receiver of system coins (usually theAccountingEngine
).auctionDeadline
- the auction's deadline
ModifyParameters
- emitted when a parameter is modifiedBuyCollateral
- emitted when someone buys collateral from an auction. Contains:id
- the ID of the auction from which collateral was boughtwad
- the bid sizeboughtCollateral
- the amount of collateral that was bought
SettleAuction
- emitted when someone settles an auction. Contains:id
- the ID of the auction settledleftoverCollateral
- the amount of collateral that hasn't been sold by the now settled auction
TerminateAuctionPrematurely
- emitted when an auction is terminated before its deadline. Contains:id
- the ID of the auction that was terminatedsender
- the address that terminated the auctioncollateralAmount
- the amount of collateral still unauctioned
3. Walkthrough
The fixed discount auction is a straightforward way (compared to English
auctions) to put SAFE collateral up for sale in exchange for system coins used to settle bad debt. Bidders are only required to allow the auction house to transfer their safeEngine.coinBalance
and can then callbuyCollateral(id: uint256
, wad: uint256)
in order to exchange their system coins for collateral which is sold at a discount
compared to its latest recorded market price. Bidders can also review the amount of collateral they can get from a specific auction by calling getCollateralBought(id: uint256
, wad: uint256)
or getApproximateCollateralBought(id: uint256
, wad: uint256)
. Note that getCollateralBought
is not marked as view
because it reads (and also updates) the redemptionPrice
from the OracleRelayer
whereas getApproximateCollateralBought
uses thelastReadRedemptionPrice
.
Bids as WAD Amounts
As opposed to English
auctions where bidders submit bids with RAD
amounts of system coins (using increaseBidSize
and decreaseSoldAmount
), buyCollateral
requires a WAD
amount of coins that are then multiplied by RAY
in order to correctly scale the amount to RAD
and transfer coins from the bidder's safeEngine.coinBalance.
There are several parameters that come together when the contract calculates the amount of collateral to send to a bidder:
The amount of system coins
wad
used when callingbuyCollateral
.wad
must be bigger than zero and bigger than or equal tominimumBid
. In casewad
is bigger thanminimumBid
, the contract will only request what it needs in order to fillremainingToRaise
. Note that in order to avoid dusty auctions resulting from computing anadjustedBid
(because of precision loss from division) the contract will automatically request10**-18
extra system coinsThe difference between the collateral's
FSM
price (the delayed price) and the latest market price stored in the medianizer (which theFSM
is connected to). The auction house uses theFSM
price by default so that, in case of an oracle attack, governance can react and temporarily disable theFSM
(in case they have power over that system component).During the
FSM
's delay, the market price (and thus the medianizer value) might change significantly and thus bidders might have to wait until a new median price feed is pushed into theFSM
so that they can profit from auctions. In order to avoid scenarios where bidders have to wait for anFSM
update and at the same time protect collateral auctions from an oracle attack, we added two variables:lowerCollateralMedianDeviation
andupperCollateralMedianDeviation
which allow the auction house to pick the medianizer price (when calculating the amount of collateral bought by a bidder) in case it deviated within certain bounds compared to theFSM
price.
The difference between the system coin's
redemptionPrice
and its market price (provided only ifsystemCoinOracle
is not null and it returns a valid price). The auction house uses theredemptionPrice
by default, although, during market shocks, there may be a significant difference between the system coin's redemption and market prices which will discourage bidding (if the market price is above redemption). This is why governance can setlowerSystemCoinMedianDeviation
andupperSystemCoinMedianDeviation
in order to allow the contract to use the system coin market price if it deviated within certain bounds from theredemptionPrice
. Governance can also setminSystemCoinMedianDeviation
so that the contract only chooses the market price in case it deviated above a certain threshold.
Similar to English
auctions, when the auction is settled (or terminated prematurely), the contract will call the LiquidationEngine
in order to removeCoinsFromAuction
(subtract bids[auctionId].amountToRaise
from LiquidationEngine.currentOnAuctionSystemCoins
).
4. Gotchas
In case someone bids an amount that is higher than the remaining amount of system coins which still need to be raised by an auction, the contract will only charge for the remaining amount plus
10**-18
extra system coins (meant to prevent dusty auctions)You must always submit a bid that is higher than or equal to
minimum(minimumBid
,subtract(bids[id].amountToRaise
,bids[id].raisedAmount))
. The contract will take care of charging only for the amount needed to cover the total remainingamountToRaise
The auctions use the system coin
redemptionPrice
by default (not its market price)
5. Examples
Last updated