Tell watchtower to retry if order is too small

cowprotocol · Feb 6, 2024 · ea64e83 · ea64e83
1 parent 63f5464
commit ea64e83
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 4 deletions.
diff --git a/src/ConstantProduct.sol b/src/ConstantProduct.sol
@@ -12,6 +12,7 @@ import {
 } from "lib/composable-cow/src/BaseConditionalOrder.sol";
 
 import {IPriceOracle} from "./interfaces/IPriceOracle.sol";
+import {IWatchtowerCustomErrors} from "./interfaces/IWatchtowerCustomErrors.sol";
 
 /**
  * @title CoW AMM
@@ -128,7 +129,9 @@ contract ConstantProduct is IConditionalOrderGenerator {
         }
 
         if (tradedAmountToken0 < data.minTradedToken0) {
-            revert IConditionalOrder.OrderNotValid("traded amount too small");
+            revert IWatchtowerCustomErrors.PollTryAtEpoch(
+                Utils.validToBucket(MAX_ORDER_DURATION) + 1, "traded amount too small"
+            );
         }
 
         order = GPv2Order.Data(

diff --git a/src/interfaces/IWatchtowerCustomErrors.sol b/src/interfaces/IWatchtowerCustomErrors.sol
@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: GPL-3.0
+pragma solidity >=0.8.0 <0.9.0;
+
+/**
+ * @title Watchtower Custom Error Interface
+ * @author CoW Protocol Developers
+ * @dev An interface that collects all custom error message for the watchtower.
+ * Different error messages lead to different watchtower behaviors when creating
+ * an order.
+ * @dev The watchtower is a service that automatically posts orders to the CoW
+ * Protocol orderbook at regular intervals.
+ */
+contract IWatchtowerCustomErrors {
+    /**
+     * No order is currently available for trading, but the watchtower should
+     * try again at the specified timestamp.
+     */
+    error PollTryAtEpoch(uint256 timestamp, string message);
+}
diff --git a/test/ConstantProduct/getTradeableOrder/ValidateOrderParametersTest.sol b/test/ConstantProduct/getTradeableOrder/ValidateOrderParametersTest.sol
@@ -2,7 +2,8 @@
 pragma solidity ^0.8.13;
 
 import {ConstantProductTestHarness} from "../ConstantProductTestHarness.sol";
-import {ConstantProduct, GPv2Order, IConditionalOrder} from "../../../src/ConstantProduct.sol";
+import {ConstantProduct, GPv2Order, IConditionalOrder} from "src/ConstantProduct.sol";
+import {IWatchtowerCustomErrors} from "src/interfaces/IWatchtowerCustomErrors.sol";
 
 abstract contract ValidateOrderParametersTest is ConstantProductTestHarness {
     function testValidOrderParameters() public {
@@ -44,12 +45,26 @@ abstract contract ValidateOrderParametersTest is ConstantProductTestHarness {
         setUpDefaultReserves(orderOwner);
         setUpDefaultReferencePairReserves(42, 1337);
 
+        uint256 smallOffset = 42;
+        require(smallOffset < constantProduct.MAX_ORDER_DURATION());
+        uint256 nextTimestamp = 1337 * constantProduct.MAX_ORDER_DURATION() + smallOffset;
+        uint256 nextBucket = 1338 * constantProduct.MAX_ORDER_DURATION();
+        require(
+            nextTimestamp % constantProduct.MAX_ORDER_DURATION() != 0,
+            "test was designed so that the timestamp doesn't fall exactly at the start of a bucket, please change the offset"
+        );
+        vm.warp(nextTimestamp);
+
         GPv2Order.Data memory order = getTradeableOrderWrapper(orderOwner, defaultData);
         require(order.sellToken == defaultData.token0, "test was design for token0 to be the sell token");
         defaultData.minTradedToken0 = order.sellAmount;
         order = getTradeableOrderWrapper(orderOwner, defaultData);
         defaultData.minTradedToken0 = order.sellAmount + 1;
-        vm.expectRevert(abi.encodeWithSelector(IConditionalOrder.OrderNotValid.selector, "traded amount too small"));
+        vm.expectRevert(
+            abi.encodeWithSelector(
+                IWatchtowerCustomErrors.PollTryAtEpoch.selector, nextBucket + 1, "traded amount too small"
+            )
+        );
         getTradeableOrderUncheckedWrapper(orderOwner, defaultData);
     }
 
@@ -58,12 +73,26 @@ abstract contract ValidateOrderParametersTest is ConstantProductTestHarness {
         setUpDefaultReserves(orderOwner);
         setUpDefaultReferencePairReserves(1337, 42);
 
+        uint256 smallOffset = 42;
+        require(smallOffset < constantProduct.MAX_ORDER_DURATION());
+        uint256 nextTimestamp = 1337 * constantProduct.MAX_ORDER_DURATION() + smallOffset;
+        uint256 nextBucket = 1338 * constantProduct.MAX_ORDER_DURATION();
+        require(
+            nextTimestamp % constantProduct.MAX_ORDER_DURATION() != 0,
+            "test was designed so that the timestamp doesn't fall exactly at the start of a bucket, please change the offset"
+        );
+        vm.warp(nextTimestamp);
+
         GPv2Order.Data memory order = getTradeableOrderWrapper(orderOwner, defaultData);
         require(order.buyToken == defaultData.token0, "test was design for token0 to be the buy token");
         defaultData.minTradedToken0 = order.buyAmount;
         order = getTradeableOrderWrapper(orderOwner, defaultData);
         defaultData.minTradedToken0 = order.buyAmount + 1;
-        vm.expectRevert(abi.encodeWithSelector(IConditionalOrder.OrderNotValid.selector, "traded amount too small"));
+        vm.expectRevert(
+            abi.encodeWithSelector(
+                IWatchtowerCustomErrors.PollTryAtEpoch.selector, nextBucket + 1, "traded amount too small"
+            )
+        );
         getTradeableOrderUncheckedWrapper(orderOwner, defaultData);
     }
 }