Enums camel case serialization (#2171)

Fixes #2168 Covered with e2e tests. --------- Co-authored-by: Devansh Kukreja <[email protected]> Co-authored-by: Devansh kukreja <[email protected]> Co-authored-by: Felix Leupold <[email protected]>
cowprotocol · Jan 6, 2024 · 482ee59 · 482ee59
1 parent 6aa02e4
commit 482ee59
Show file tree

Hide file tree

Showing 31 changed files with 109 additions and 108 deletions.
diff --git a/crates/autopilot/src/driver_model.rs b/crates/autopilot/src/driver_model.rs
@@ -23,7 +23,7 @@ pub mod quote {
     }
 
     #[derive(Clone, Debug, Default, Serialize)]
-    #[serde(rename_all = "lowercase")]
+    #[serde(rename_all = "camelCase")]
     pub enum Kind {
         #[default]
         Buy,
@@ -123,7 +123,7 @@ pub mod solve {
     }
 
     #[derive(Clone, Debug, Serialize, Deserialize)]
-    #[serde(rename_all = "lowercase")]
+    #[serde(rename_all = "camelCase")]
     pub enum Class {
         Market,
         Limit,
@@ -142,7 +142,7 @@ pub mod solve {
     }
 
     #[derive(Clone, Debug, Serialize)]
-    #[serde(rename_all = "lowercase", tag = "kind")]
+    #[serde(rename_all = "camelCase", tag = "kind")]
     pub enum FeePolicy {
         /// If the order receives more than expected (positive deviation from
         /// quoted amounts) pay the protocol a factor of the achieved

diff --git a/crates/driver/openapi.yml b/crates/driver/openapi.yml
@@ -427,7 +427,7 @@ components:
       properties:
         kind:
           type: string
-          enum: ["priceimprovement"]
+          enum: ["priceImprovement"]
         maxVolumeFactor:
           description: Never charge more than that percentage of the order volume.
           type: number

diff --git a/crates/driver/src/infra/api/routes/quote/dto/order.rs b/crates/driver/src/infra/api/routes/quote/dto/order.rs
@@ -36,7 +36,7 @@ pub struct Order {
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum Kind {
     Sell,
     Buy,

diff --git a/crates/driver/src/infra/api/routes/solve/dto/auction.rs b/crates/driver/src/infra/api/routes/solve/dto/auction.rs
@@ -254,7 +254,7 @@ struct Order {
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum Kind {
     Sell,
     Buy,
@@ -272,7 +272,7 @@ struct Interaction {
 }
 
 #[derive(Debug, Default, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum SellTokenBalance {
     #[default]
     Erc20,
@@ -281,7 +281,7 @@ enum SellTokenBalance {
 }
 
 #[derive(Debug, Default, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum BuyTokenBalance {
     #[default]
     Erc20,
@@ -298,15 +298,15 @@ enum SigningScheme {
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum Class {
     Market,
     Limit,
     Liquidity,
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", tag = "kind", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", tag = "kind", deny_unknown_fields)]
 enum FeePolicy {
     #[serde(rename_all = "camelCase")]
     PriceImprovement { factor: f64, max_volume_factor: f64 },

diff --git a/crates/driver/src/infra/solver/dto/auction.rs b/crates/driver/src/infra/solver/dto/auction.rs
@@ -237,14 +237,14 @@ struct Order {
 }
 
 #[derive(Debug, Serialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum Kind {
     Sell,
     Buy,
 }
 
 #[derive(Debug, Serialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum Class {
     Market,
     Limit,
@@ -267,7 +267,7 @@ struct Token {
 // TODO Remove dead_code
 #[allow(dead_code, clippy::enum_variant_names)]
 #[derive(Debug, Serialize)]
-#[serde(tag = "kind", rename_all = "lowercase")]
+#[serde(tag = "kind", rename_all = "camelCase")]
 enum Liquidity {
     ConstantProduct(ConstantProductPool),
     WeightedProduct(WeightedProductPool),
@@ -325,7 +325,7 @@ struct WeightedProductReserve {
 }
 
 #[derive(Debug, Serialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum WeightedProductVersion {
     V0,
     V3Plus,

diff --git a/crates/driver/src/infra/solver/dto/notification.rs b/crates/driver/src/infra/solver/dto/notification.rs
@@ -95,7 +95,7 @@ pub struct Notification {
 
 #[serde_as]
 #[derive(Debug, Serialize)]
-#[serde(rename_all = "lowercase", tag = "kind")]
+#[serde(rename_all = "camelCase", tag = "kind")]
 pub enum Kind {
     Timeout,
     EmptySolution,

diff --git a/crates/driver/src/infra/solver/dto/solution.rs b/crates/driver/src/infra/solver/dto/solution.rs
@@ -234,7 +234,7 @@ pub struct Solution {
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(tag = "kind", rename_all = "lowercase", deny_unknown_fields)]
+#[serde(tag = "kind", rename_all = "camelCase", deny_unknown_fields)]
 enum Trade {
     Fulfillment(Fulfillment),
     Jit(JitTrade),
@@ -287,14 +287,14 @@ struct JitOrder {
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum Kind {
     Sell,
     Buy,
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(tag = "kind", rename_all = "lowercase", deny_unknown_fields)]
+#[serde(tag = "kind", rename_all = "camelCase", deny_unknown_fields)]
 enum Interaction {
     Liquidity(LiquidityInteraction),
     Custom(CustomInteraction),
@@ -350,7 +350,7 @@ struct Allowance {
 }
 
 #[derive(Debug, Default, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum SellTokenBalance {
     #[default]
     Erc20,
@@ -359,15 +359,15 @@ enum SellTokenBalance {
 }
 
 #[derive(Debug, Default, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum BuyTokenBalance {
     #[default]
     Erc20,
     Internal,
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields)]
+#[serde(rename_all = "camelCase", deny_unknown_fields)]
 enum SigningScheme {
     Eip712,
     EthSign,
@@ -377,7 +377,7 @@ enum SigningScheme {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", deny_unknown_fields, tag = "kind")]
+#[serde(rename_all = "camelCase", deny_unknown_fields, tag = "kind")]
 pub enum Score {
     Solver {
         #[serde_as(as = "serialize::U256")]

diff --git a/crates/driver/src/tests/setup/driver.rs b/crates/driver/src/tests/setup/driver.rs
@@ -95,7 +95,7 @@ pub fn solve_req(test: &Test) -> serde_json::Value {
             "signingScheme": "eip712",
             "signature": format!("0x{}", hex::encode(quote.order_signature(&test.blockchain))),
             "feePolicies": [{
-                "kind": "priceimprovement",
+                "kind": "priceImprovement",
                 "factor": 0.5,
                 "maxVolumeFactor": 0.06,
             },

diff --git a/crates/driver/src/tests/setup/mod.rs b/crates/driver/src/tests/setup/mod.rs
@@ -61,7 +61,7 @@ pub enum Partial {
 
 #[serde_as]
 #[derive(Debug, Clone, serde::Serialize)]
-#[serde(rename_all = "lowercase", tag = "kind")]
+#[serde(rename_all = "camelCase", tag = "kind")]
 pub enum Score {
     Solver {
         #[serde_as(as = "serialize::U256")]

diff --git a/crates/e2e/tests/e2e/colocation_partial_fill.rs b/crates/e2e/tests/e2e/colocation_partial_fill.rs
@@ -7,7 +7,7 @@ use {
     ethcontract::U256,
     model::{
         order::{OrderCreation, OrderKind},
-        signature::EcdsaSigningScheme,
+        signature::{EcdsaSigningScheme, Signature, SigningScheme},
     },
     secp256k1::SecretKey,
     shared::ethrpc::Web3,
@@ -73,10 +73,11 @@ async fn test(web3: Web3) {
         valid_to: model::time::now_in_epoch_seconds() + 300,
         partially_fillable: true,
         kind: OrderKind::Sell,
+        signature: Signature::default_with(SigningScheme::EthSign),
         ..Default::default()
     }
     .sign(
-        EcdsaSigningScheme::Eip712,
+        EcdsaSigningScheme::EthSign,
         &onchain.contracts().domain_separator,
         SecretKeyRef::from(&SecretKey::from_slice(trader.private_key()).unwrap()),
     );

diff --git a/crates/solvers/openapi.yml b/crates/solvers/openapi.yml
@@ -273,7 +273,7 @@ components:
       properties:
         kind:
           type: string
-          enum: [constantproduct]
+          enum: [constantProduct]
         tokens:
           description: |
             A mapping of token address to its reserve amounts.
@@ -294,7 +294,7 @@ components:
       properties:
         kind:
           type: string
-          enum: [weightedproduct]
+          enum: [weightedProduct]
         tokens:
           description: |
             A mapping of token address to its reserve amounts with weights.
@@ -314,7 +314,7 @@ components:
           $ref: "#/components/schemas/Decimal"
         version:
           type: string
-          enum: ["v0", "v3plus"]
+          enum: ["v0", "v3Plus"]
 
     StablePool:
       description: |
@@ -362,7 +362,7 @@ components:
       properties:
         kind:
           type: string
-          enum: [concentratedliquidity]
+          enum: [concentratedLiquidity]
         tokens:
           type: array
           items:
@@ -397,7 +397,7 @@ components:
       properties:
         kind:
           type: string
-          enum: [limitorder]
+          enum: [limitOrder]
         hash:
           $ref: "#/components/schemas/Digest"
         makerToken:
@@ -763,7 +763,7 @@ components:
               properties:
                 kind: 
                   type: string
-                  enum: [riskadjusted]
+                  enum: [riskAdjusted]
                 successProbability: 
                   description: |
                     The revert probability of the solution. Used by the driver to compute a risk-adjusted score.

diff --git a/crates/solvers/src/api/routes/notify/dto/notification.rs b/crates/solvers/src/api/routes/notify/dto/notification.rs
@@ -109,7 +109,7 @@ pub struct Notification {
 
 #[serde_as]
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase", tag = "kind")]
+#[serde(rename_all = "camelCase", tag = "kind")]
 pub enum Kind {
     Timeout,
     EmptySolution,

diff --git a/crates/solvers/src/api/routes/solve/dto/auction.rs b/crates/solvers/src/api/routes/solve/dto/auction.rs
@@ -117,14 +117,14 @@ struct Order {
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum Kind {
     Sell,
     Buy,
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum Class {
     Market,
     Limit,
@@ -146,7 +146,7 @@ struct Token {
 
 #[allow(clippy::enum_variant_names)]
 #[derive(Debug, Deserialize)]
-#[serde(tag = "kind", rename_all = "lowercase", deny_unknown_fields)]
+#[serde(tag = "kind", rename_all = "camelCase", deny_unknown_fields)]
 enum Liquidity {
     ConstantProduct(ConstantProductPool),
     WeightedProduct(WeightedProductPool),
@@ -227,7 +227,7 @@ struct WeightedProductReserve {
 }
 
 #[derive(Debug, Deserialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum WeightedProductVersion {
     V0,
     V3Plus,

diff --git a/crates/solvers/src/api/routes/solve/dto/solution.rs b/crates/solvers/src/api/routes/solve/dto/solution.rs
@@ -153,7 +153,7 @@ struct Solution {
 }
 
 #[derive(Debug, Serialize)]
-#[serde(tag = "kind", rename_all = "lowercase")]
+#[serde(tag = "kind", rename_all = "camelCase")]
 enum Trade {
     Fulfillment(Fulfillment),
     Jit(JitTrade),
@@ -207,14 +207,14 @@ struct JitOrder {
 }
 
 #[derive(Debug, Serialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum Kind {
     Sell,
     Buy,
 }
 
 #[derive(Debug, Serialize)]
-#[serde(tag = "kind", rename_all = "lowercase")]
+#[serde(tag = "kind", rename_all = "camelCase")]
 enum Interaction {
     Liquidity(LiquidityInteraction),
     Custom(CustomInteraction),
@@ -284,7 +284,7 @@ struct Allowance {
 }
 
 #[derive(Debug, Default, Serialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum SellTokenBalance {
     #[default]
     Erc20,
@@ -293,15 +293,15 @@ enum SellTokenBalance {
 }
 
 #[derive(Debug, Default, Serialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum BuyTokenBalance {
     #[default]
     Erc20,
     Internal,
 }
 
 #[derive(Debug, Serialize)]
-#[serde(rename_all = "lowercase")]
+#[serde(rename_all = "camelCase")]
 enum SigningScheme {
     Eip712,
     EthSign,
@@ -312,7 +312,7 @@ enum SigningScheme {
 /// A score for a solution. The score is used to rank solutions.
 #[serde_as]
 #[derive(Debug, Serialize)]
-#[serde(rename_all = "lowercase", tag = "kind")]
+#[serde(rename_all = "camelCase", tag = "kind")]
 pub enum Score {
     Solver {
         #[serde_as(as = "serialize::U256")]