Cat - Detailed Documentation - Maker Protocol Technical Docs

Contract Name: cat.sol
Type/Category: DSS
​Associated MCD System Diagram​
​Contract Source​
​Etherscan​
1. Introduction (Summary)
The Cat is the system's liquidation agent, it enables keepers to mark positions as unsafe and sends them to auction.
2. Contract Details
Glossary (Cat)
Math
mul(uint, uint)/rmul(uint, uint) - will revert on overflow or underflow
bite(bytes32, address) will revert if lot or art are larger than or equal to 2^255.
bite will not leave a Vault with debt and no collateral.
Auth
wards are allowed to call protected functions (Administration and cage())
Storage
ilks stores Ilk structs
Ilk is the struct with the address of the collateral auction contract (flip), the penalty for that collateral to be liquidated (chop) and the maximum size of collateral that can be auctioned at once (dunk).
live must be 1 for the Cat to bite. (see cage in mechanisms)
box the limit on the debt and penalty fees available for auction. [RAD]
dunk ("debt chunk") amount of debt plus penalty fee per auction, in Dai. [RAD]
vat address that conforms to a VatLike interface (see vat documentation for more info). It is set during the constructor and cannot be changed.
vow address that conforms to a VowLike interface (see vow documentation for more info).
The values of all parameters here (except vat) are changeable by an address that is relyed on. For instance, the End module should be authed to allow for it to call cage() and update live from 1 to 0. Governance (through an authed address) should be able to add collateral types to Cat, update their parameters, and change the vow.
Unsafe
bite can be called at anytime but will only succeed if the Vault is unsafe. A Vault is unsafe when its locked collateral (ink) times its collateral's liquidation price (spot) is less than its debt (art times the fee for the collateral rate). Liquidation price is the oracle-reported price scaled by the collateral's liquidation ratio.
Events
Bite: emitted when a bite(bytes32, address) is successfully executed. Contains:
ilk: Collateral
urn: Vault address
ink: see lot in bite
art: see art in bite
tab: see tab in bite
flip: address of the auction contract
id: ID of the auction in the Flipper
3. Key Mechanisms & Concepts
cage()
auth
sets live to 0 (prevents bite). See End documentation for further description.
Once live=0 it cannot be set back to 1.
bite(bytes32 ilk, address urn)
bytes32 ilk parameter represents the collateral type that is being bitten.
address urn the address that identifies the Vault being bitten.
returns uint id which is the ID of the new auction in the Flipper.
bite checks if the Vault is in an unsafe position and if it is, it starts a Flip auction for a piece of the collateral to cover a share of the debt.
The following is a line-by-line explanation of what bite does.
1
function bite(bytes32 ilk, address urn) public returns (uint id) {
2
  // Get the rate, spot, and dust from the ilk in the vat.
3
  (,uint256 rate,uint256 spot,,uint256 dust) = vat.ilks(ilk);
4
  // get the ink and art from the urn from the Vat.
5
  (uint256 ink, uint256 art) = vat.urns(ilk, urn);
6
​
7
  // ensure End has not happened
8
  require(live == 1);
9
  // require the Vault to be unsafe (see definition above).
10
  require(spot > 0 && mul(ink, spot) < mul(art, rate), "Cat/not-unsafe");
11
​
12
	// Loads the `ilk` data into memory as an optimization.
13
  Ilk memory milk = ilks[ilk];
14
  // Declares a variable that will be assigned in the following scope.
15
  uint256 dart;
16
​
17
	// Defines a new scope, this prevents a stack too deep error in solidity
18
  {
19
		// Calculate the available space in the box
20
    uint256 room = sub(box, litter);
21
​
22
    // test whether the remaining space in the litterbox is dusty
23
    require(litter < box && room >= dust, "Cat/liquidation-limit-hit");
24
​
25
		// Sets the amount of debt to be covered by the auction.
26
    // (smaller of either the amount of normalized debt, maximum debt chunk size, or space in the box)
27
    // divided by the rate, divided by the penalty fee.
28
    dart = min(art, mul(min(milk.dunk, room), WAD) / rate / milk.chop);
29
  }
30
​
31
	// Takes the minimum of the collateral balance or the
32
  // amount of collateral represented by the debt to be covered
33
  uint256 dink = min(ink, mul(ink, dart) / art);
34
​
35
	// Prevents no-collateral auctions
36
  require(dart >  0      && dink >  0     , "Cat/null-auction");
37
  // Protects against int overflow when converting from uint to int
38
  require(dart <= 2**255 && dink <= 2**255, "Cat/overflow"    );
39
​
40
	// Called in this way, vat.grab will:
41
  // - Remove the dink and the dart from the bitten Vault (urn)
42
  // - Adds the collateral (dink) to the Cat's gem
43
  // - Adds the debt (dart) to the Vow's debt (vat.sin[vow])
44
  // - Increases the total unbacked dai (vice) in the system
45
  // This may leave the CDP in a dusty state
46
  vat.grab(
47
    ilk, urn, address(this), address(vow), -int256(dink), -int256(dart)
48
  );
49
  // Adds the debt to the debt-queue in Vow (Vow.Sin and Vow.sin[now])
50
  vow.fess(mul(dart, rate));
51
​
52
  { // Avoid stack too deep
53
    // This calcuation will overflow if dart*rate exceeds ~10^14,
54
    // i.e. the maximum dunk is roughly 100 trillion DAI.
55
    // Multiplies the accumulated rate by the normalized debt to be covered 
56
    // to get the total debt tab (debt + stability fee + liquidation penalty) for the auction.
57
    uint256 tab = mul(mul(dart, rate), milk.chop) / WAD;
58
    // Updates the amount of litter in the box
59
    litter = add(litter, tab);
60
​
61
		// Calls kick on the collateral's Flipper contract.
62
    // tab is the total debt to be sent to auction
63
    // gal: address(vow) sets up the Vow as the recipient of the Dai income for this auction
64
    // bid: 0 indicates that this is the opening bid
65
    // This moves the collateral from the Cat's gem to the Flipper's gem in the Vat
66
    id = Kicker(milk.flip).kick({
67
        urn: urn,
68
        gal: address(vow),
69
        tab: tab,
70
        lot: dink,
71
        bid: 0
72
    });
73
  }
74
​
75
  // Emits an event about the bite to notify actors (for instance keepers) about the new auction
76
  emit Bite(ilk, urn, dink, dart, mul(dart, rate), milk.flip, id);
77
}
Copied!
Administration
Various file function signatures for administering Cat:
Setting new vow (file(bytes32, address))
Setting new collateral (file(bytes32, bytes32, address))
Setting penalty or dunk size for collateral (file(bytes32, bytes32, uint))
Usage
The primary usage will be for keepers to call bite on a Vault they believe to be unsafe in order to start the auction process.
4. Gotchas (Potential source of user error)
When the Cat is upgraded, there are multiple references to it that must be updated at the same time (End, Vat.rely, Vow.rely). It must also rely on the End, the system's pause.proxy()
A Vat upgrade will require a new Cat
The Cat stores each Ilk's liquidation penalty and maximum auction size.
Each ilk will be initiated with the file for their Flipper; however, auctions cannot start until file is also called to set the chop and the dunk. Without these auctions for either 0 gems or 0 dai would be created by calling bite on an unsafe Vault.
bite needs to be called n times where n = urn.ink / ilks[ilk].dunk if n > 1. This allows for the possibility that the Vault becomes safe between bite calls either through increased collateral (in value or quantity), or decreased debt.
Calling bite returns the auction id and emits and event with the id. This is required to bid in the Flipper on the auction.
5. Failure Modes (Bounds on Operating Conditions & External Risk Factors)
Coding Error
A bug in the Cat could lead to loss (or locking) of Dai and Collateral by assigning it to an address that cannot recover it (i.e. a bad Vow address or an incorrectly programmed Flipper). The main coding failure mode of Cat is if it has a bug that causes auctions to cease to function. This would require upgrading the system to a corrected Cat contract. If there is a bug in Cat that reverts on cage then it would cause Shutdown could fail (until a correct Cat is launched).
Feeds
The Cat relies indirectly on the price Feeds as it looks to the Vat's tracking of the collateral prices (spot) to determine Vault safety. If this system breaks down, it could lead to theft of collateral (too low spot) or unbacked Dai (incorrectly high spot).
Governance
Governance can authorize and configure new collaterals for Cat. This could lead to misconfiguration or inefficiencies in the system. Misconfiguration could cause Cat not to operate properly or at all. For instance, if an Ilk.dunk is set to be greater than 2**255 could allow for very, very large Vaults to be un-bite-able.
Inefficiencies in the dunk or chop could affect auctions. For instance, a dunk that is too large or too small could lead to disincentives for keepers to participate in auctions. A chop that is too small would not sufficiently dis-incentivize risky Vaults and too large could lead to it being converted to bad debt. Further discussion of how the parameters could lead to system attacks is described in this Auction Grinding paper.
Flipper
The Cat relies on an external Flipper contract to run the auction and moves the collateral from the Cat to the Flipper contracts in the Vat. A faulty collateral auction contract could result in the loss of collateral or dai or non-functioning auctions.

Miscellaneous - Previous

Liquidations 1.2 System (Deprecated)

Flipper - Detailed Documentation

Last modified 1yr ago

Export as PDF

Copy link

Contents

1. Introduction (Summary)

2. Contract Details

Glossary (Cat)

3. Key Mechanisms & Concepts

Usage

4. Gotchas (Potential source of user error)

5. Failure Modes (Bounds on Operating Conditions & External Risk Factors)