Fix cowswap orders

- Use new quote endpoint to get fees

Author: Uxio0

gnosis/protocol/gnosis_protocol_api.py

@@ -77,27 +77,34 @@ def weth_address(self) -> ChecksumAddress:
         else:  # XDAI
             return ChecksumAddress("0x6A023CCd1ff6F2045C3309768eAd9E68F978f6e1")
 
-    def get_fee(self, order: Order) -> int:
-        if order.is_sell_order():
-            amount = order.sellAmount
-        else:
-            amount = order.buyAmount
-        url = (
-            self.base_url
-            + f"fee/?sellToken={order.sellToken}&buyToken={order.buyToken}"
-            f"&amount={amount}&kind={order.kind}"
-        )
-        result = self.http_session.get(url).json()
-        if "amount" in result:
-            return int(result["amount"])
+    def get_fee(self, order: Order, from_address: ChecksumAddress) -> int:
+        url = self.base_url + "quote"
+        data_json = {
+            "sellToken": order.sellToken.lower(),
+            "buyToken": order.buyToken.lower(),
+            "sellAmountBeforeFee": str(order.sellAmount),
+            "validTo": order.validTo,
+            "appData": HexBytes(order.appData).hex()
+            if isinstance(order.appData, bytes)
+            else order.appData,
+            "feeAmount": str(order.feeAmount),
+            "kind": order.kind,
+            "partiallyFillable": order.partiallyFillable,
+            "signingScheme": "ethsign",
+            "from": from_address,
+            "priceQuality": "fast",
+        }
+        r = self.http_session.post(url, json=data_json)
+        if r.ok:
+            return int(r.json()["quote"]["feeAmount"])
         else:
-            return 0
+            return ErrorResponse(r.json())
 
     def place_order(
         self, order: Order, private_key: HexStr
     ) -> Union[HexStr, ErrorResponse]:
         """
-        Place order. If `feeAmount=0` in Order it will be calculated calling `get_fee(order)`
+        Place order. If `feeAmount=0` in Order it will be calculated calling `get_fee(order, from_address)`
 
         :return: UUID for the order as an hex hash
         """
@@ -106,7 +113,13 @@ def place_order(
         ), "Order buyAmount and sellAmount cannot be empty"
 
         url = self.base_url + "orders/"
-        order.feeAmount = order.feeAmount or self.get_fee(order)
+        from_address = Account.from_key(private_key).address
+        if not order.feeAmount:
+            fee_amount = self.get_fee(order, from_address)
+            if "errorType" in fee_amount:  # ErrorResponse
+                return fee_amount
+            order.feeAmount = fee_amount
+
         signable_hash = eip712_encode_hash(
             order.get_eip712_structured_data(
                 self.network.value, self.settlement_contract_address
@@ -129,7 +142,7 @@ def place_order(
             "partiallyFillable": order.partiallyFillable,
             "signature": signed_message.signature.hex(),
             "signingScheme": "ethsign",
-            "from": Account.from_key(private_key).address,
+            "from": from_address,
         }
         r = self.http_session.post(url, json=data_json)
         if r.ok:

gnosis/protocol/tests/test_gnosis_protocol_api.py

@@ -17,9 +17,8 @@ def setUpClass(cls):
         super().setUpClass()
         cls.mainnet_gnosis_protocol_api = GnosisProtocolAPI(EthereumNetwork.MAINNET)
         cls.goerli_gnosis_protocol_api = GnosisProtocolAPI(EthereumNetwork.GOERLI)
-        cls.gno_token_address = "0x6810e776880C02933D47DB1b9fc05908e5386b96"
-        cls.weth_token_address = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
-        cls.rinkeby_dai_address = "0x5592EC0cfb4dbc12D3aB100b257153436a1f0FEa"
+        cls.mainnet_gno_token_address = "0x6810e776880C02933D47DB1b9fc05908e5386b96"
+        cls.goerli_cow_token_address = "0x3430d04E42a722c5Ae52C5Bffbf1F230C2677600"
 
     def test_api_is_available(self):
         random_owner = Account.create().address
@@ -36,7 +35,10 @@ def test_api_is_available(self):
     def test_get_estimated_amount(self):
         gnosis_protocol_api = GnosisProtocolAPI(EthereumNetwork.MAINNET)
         response = gnosis_protocol_api.get_estimated_amount(
-            self.gno_token_address, self.gno_token_address, OrderKind.SELL, 1
+            self.mainnet_gno_token_address,
+            self.mainnet_gno_token_address,
+            OrderKind.SELL,
+            1,
         )
         self.assertDictEqual(
             response,
@@ -48,26 +50,29 @@ def test_get_estimated_amount(self):
 
         response = gnosis_protocol_api.get_estimated_amount(
             "0x6820e776880c02933d47db1b9fc05908e5386b96",
-            self.gno_token_address,
+            self.mainnet_gno_token_address,
             OrderKind.SELL,
             1,
         )
         self.assertIn("errorType", response)
         self.assertIn("description", response)
 
         response = gnosis_protocol_api.get_estimated_amount(
-            self.gno_token_address, self.weth_token_address, OrderKind.SELL, int(1e18)
+            self.mainnet_gno_token_address,
+            self.mainnet_gnosis_protocol_api.weth_address,
+            OrderKind.SELL,
+            int(1e18),
         )
         amount = int(response["amount"]) / 1e18
         self.assertGreater(amount, 0)
         self.assertLess(amount, 1)
 
     def test_get_fee(self):
         order = Order(
-            sellToken=self.gno_token_address,
-            buyToken=self.gno_token_address,
+            sellToken=self.mainnet_gno_token_address,
+            buyToken=self.mainnet_gno_token_address,
             receiver=NULL_ADDRESS,
-            sellAmount=1,
+            sellAmount=int(1e18),
             buyAmount=1,
             validTo=int(time()) + 3600,
             appData=Web3.keccak(text="hola"),
@@ -77,7 +82,18 @@ def test_get_fee(self):
             sellTokenBalance="erc20",
             buyTokenBalance="erc20",
         )
-        self.assertGreaterEqual(self.goerli_gnosis_protocol_api.get_fee(order), 0)
+        from_address = Account.create().address
+        self.assertEqual(
+            self.mainnet_gnosis_protocol_api.get_fee(order, from_address),
+            {
+                "errorType": "SameBuyAndSellToken",
+                "description": "Buy token is the same as the sell token.",
+            },
+        )
+        order.buyToken = self.mainnet_gnosis_protocol_api.weth_address
+        self.assertGreaterEqual(
+            self.mainnet_gnosis_protocol_api.get_fee(order, from_address), 0
+        )
 
     def test_get_trades(self):
         mainnet_order_ui = "0x65F1206182C77A040ED41D507B59C622FA94AB5E71CCA567202CFF3909F3D5C4DBE338E45276630FD8237149DD47EE027AF26F9C619723D0"
@@ -101,8 +117,8 @@ def test_get_trades(self):
 
     def test_place_order(self):
         order = Order(
-            sellToken=self.gno_token_address,
-            buyToken=self.gno_token_address,
+            sellToken=self.mainnet_gno_token_address,
+            buyToken=self.mainnet_gno_token_address,
             receiver=NULL_ADDRESS,
             sellAmount=1,
             buyAmount=1,
@@ -129,7 +145,7 @@ def test_place_order(self):
         )
 
         order.sellToken = self.goerli_gnosis_protocol_api.weth_address
-        order.buyToken = self.rinkeby_dai_address
+        order.buyToken = self.goerli_cow_token_address
         order_id = self.goerli_gnosis_protocol_api.place_order(
             order, Account().create().key
         )