Skip to content

Commit

Permalink
CDAuctioneer: handle edge cases when setting auction parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
@0xJem
0xJem committed Jan 7, 2025
1 parent 00745b1 commit 76d458c
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 18 deletions.
19 changes: 15 additions & 4 deletions src/policies/CDAuctioneer.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,6 @@ contract CDAuctioneer is IConvertibleDepositAuctioneer, Policy, RolesConsumer, R

// Cycle through the ticks until the deposit is fully converted
while (remainingDeposit > 0) {
// TODO what happens if there is a remaining deposit that cannot be converted? Needs an escape hatch
// consider returning the remaining deposit as a value

// TODO what if the target is reached?

uint256 depositAmount = remainingDeposit;
Expand Down Expand Up @@ -379,7 +376,9 @@ contract CDAuctioneer is IConvertibleDepositAuctioneer, Policy, RolesConsumer, R

/// @inheritdoc IConvertibleDepositAuctioneer
/// @dev This function performs the following:
/// - TODO
/// - Performs validation of the inputs
/// - Sets the auction parameters
/// - Adjusts the current tick capacity and price, if necessary
///
/// This function reverts if:
/// - The caller does not have the ROLE_HEART role
Expand All @@ -398,6 +397,18 @@ contract CDAuctioneer is IConvertibleDepositAuctioneer, Policy, RolesConsumer, R

_setAuctionParameters(target_, tickSize_, minPrice_);

// Ensure that the tick capacity is not larger than the new tick size
// Otherwise, excess OHM will be converted
if (tickSize_ < _previousTick.capacity) {
_previousTick.capacity = tickSize_;
}

// Ensure that the minimum price is enforced
// Otherwise, OHM will be converted at a price lower than the minimum
if (minPrice_ < _previousTick.price) {
_previousTick.price = minPrice_;
}

return remainder;
}

Expand Down
124 changes: 110 additions & 14 deletions src/test/policies/ConvertibleDepositAuctioneer/setAuctionParameters.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit
// [X] it sets the parameters
// when the new target is 0
// [X] it succeeds
// [X] it does not set the tick capacity
// [X] it does not set the tick price
// [X] it does not change the current tick capacity
// [X] it does not change the current tick price
// when the new tick size is 0
// [X] it reverts
// when the new min price is 0
Expand All @@ -24,9 +24,17 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit
// [X] it does not change the current tick price
// given the tick price has never been set
// [X] it sets the parameters
// [X] it does not set the tick capacity
// [X] it does not set the tick price
// [X] it does not change the current tick capacity
// [X] it does not change the current tick price
// [X] it emits an event
// when the new tick size is less than the current tick capacity
// [X] the tick capacity is set to the new tick size
// when the new tick size is >= the current tick capacity
// [X] the tick capacity is unchanged
// when the new min price is > than the current tick price
// [X] the tick price is set to the new min price
// when the new min price is <= the current tick price
// [X] the tick price is unchanged

// TODO determine expected behaviour of remainder

Expand Down Expand Up @@ -61,8 +69,8 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit
vm.warp(lastUpdate + 1);

uint256 newTarget = 0;
uint256 newTickSize = 101;
uint256 newMinPrice = 102;
uint256 newTickSize = 11e9;
uint256 newMinPrice = 16e18;

// Expect event
vm.expectEmit(true, true, true, true);
Expand Down Expand Up @@ -90,7 +98,7 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit

// Call function
vm.prank(heart);
auctioneer.setAuctionParameters(100, 0, 102);
auctioneer.setAuctionParameters(21e9, 0, 16e18);
}

function test_minPriceZero_reverts() public givenInitialized {
Expand All @@ -104,7 +112,7 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit

// Call function
vm.prank(heart);
auctioneer.setAuctionParameters(100, 101, 0);
auctioneer.setAuctionParameters(21e9, 11e9, 0);
}

function test_contractInactive()
Expand All @@ -121,9 +129,9 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit
// Warp to change the block timestamp
vm.warp(lastUpdate + 1);

uint256 newTarget = 100;
uint256 newTickSize = 101;
uint256 newMinPrice = 102;
uint256 newTarget = 21e9;
uint256 newTickSize = 11e9;
uint256 newMinPrice = 16e18;

// Expect event
vm.expectEmit(true, true, true, true);
Expand All @@ -150,9 +158,9 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit
// Warp to change the block timestamp
vm.warp(lastUpdate + 1);

uint256 newTarget = 100;
uint256 newTickSize = 101;
uint256 newMinPrice = 102;
uint256 newTarget = 21e9;
uint256 newTickSize = 11e9;
uint256 newMinPrice = 16e18;

// Expect event
vm.expectEmit(true, true, true, true);
Expand All @@ -169,4 +177,92 @@ contract ConvertibleDepositAuctioneerAuctionParametersTest is ConvertibleDeposit
// Values are unchanged
_assertPreviousTick(lastCapacity, lastPrice);
}

function test_newTickSizeLessThanCurrentTickCapacity(
uint256 newTickSize_
) public givenInitialized {
uint48 lastUpdate = uint48(block.timestamp);

// Warp to change the block timestamp
vm.warp(lastUpdate + 1);

uint256 newTickSize = bound(newTickSize_, 1, TICK_SIZE);

// Call function
vm.prank(heart);
auctioneer.setAuctionParameters(TARGET, newTickSize, MIN_PRICE);

// Assert state
_assertAuctionParameters(TARGET, newTickSize, MIN_PRICE, lastUpdate);

// Assert current tick
// Tick capacity has been adjusted to the new tick size
_assertPreviousTick(newTickSize, MIN_PRICE);
}

function test_newTickSizeGreaterThanCurrentTickCapacity(
uint256 newTickSize_
) public givenInitialized {
uint48 lastUpdate = uint48(block.timestamp);

// Warp to change the block timestamp
vm.warp(lastUpdate + 1);

uint256 newTickSize = bound(newTickSize_, TICK_SIZE, 2 * TICK_SIZE);

// Call function
vm.prank(heart);
auctioneer.setAuctionParameters(TARGET, newTickSize, MIN_PRICE);

// Assert state
_assertAuctionParameters(TARGET, newTickSize, MIN_PRICE, lastUpdate);

// Assert current tick
// Tick capacity has been unchanged
_assertPreviousTick(TICK_SIZE, MIN_PRICE);
}

function test_newMinPriceGreaterThanCurrentTickPrice(
uint256 newMinPrice_
) public givenInitialized {
uint48 lastUpdate = uint48(block.timestamp);

// Warp to change the block timestamp
vm.warp(lastUpdate + 1);

uint256 newMinPrice = bound(newMinPrice_, MIN_PRICE + 1, 2 * MIN_PRICE);

// Call function
vm.prank(heart);
auctioneer.setAuctionParameters(TARGET, TICK_SIZE, newMinPrice);

// Assert state
_assertAuctionParameters(TARGET, TICK_SIZE, newMinPrice, lastUpdate);

// Assert current tick
// Tick price has been set to the new min price
_assertPreviousTick(TICK_SIZE, newMinPrice);
}

function test_newMinPriceLessThanCurrentTickPrice(
uint256 newMinPrice_
) public givenInitialized {
uint48 lastUpdate = uint48(block.timestamp);

// Warp to change the block timestamp
vm.warp(lastUpdate + 1);

uint256 newMinPrice = bound(newMinPrice_, 1, MIN_PRICE);

// Call function
vm.prank(heart);
auctioneer.setAuctionParameters(TARGET, TICK_SIZE, newMinPrice);

// Assert state
_assertAuctionParameters(TARGET, TICK_SIZE, newMinPrice, lastUpdate);

// Assert current tick
// Tick price has been unchanged
_assertPreviousTick(TICK_SIZE, MIN_PRICE);
}
}

0 comments on commit 76d458c

Please sign in to comment.