Add is_winner to solver competition endpoints

cowprotocol · Nov 14, 2024 · c7cde9c · c7cde9c
1 parent 5671152
commit c7cde9c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/crates/autopilot/src/run_loop.rs b/crates/autopilot/src/run_loop.rs
@@ -476,6 +476,7 @@ impl RunLoop {
                         .iter()
                         .map(|(token, price)| (token.0, price.get().into()))
                         .collect(),
+                    is_winner: participant.is_winner(),
                 })
                 .collect(),
         };

diff --git a/crates/e2e/tests/e2e/solver_competition.rs b/crates/e2e/tests/e2e/solver_competition.rs
@@ -125,8 +125,10 @@ async fn solver_competition(web3: Web3) {
 
     // Non winning candidate
     assert!(competition.common.solutions[0].ranking == 2);
+    assert!(competition.common.solutions[0].is_winner == false);
     // Winning candidate
     assert!(competition.common.solutions[1].ranking == 1);
+    assert!(competition.common.solutions[1].is_winner == true);
 }
 
 async fn fairness_check(web3: Web3) {

diff --git a/crates/model/src/solver_competition.rs b/crates/model/src/solver_competition.rs
@@ -54,6 +54,7 @@ pub struct SolverSettlement {
     #[serde_as(as = "BTreeMap<_, HexOrDecimalU256>")]
     pub clearing_prices: BTreeMap<H160, U256>,
     pub orders: Vec<Order>,
+    pub is_winner: bool,
 }
 
 #[serde_as]
@@ -208,6 +209,7 @@ mod tests {
                             executed_amount: 14.into(),
                         },
                     ],
+                    is_winner: true,
                 }],
             },
         };

diff --git a/crates/orderbook/openapi.yml b/crates/orderbook/openapi.yml
@@ -1504,6 +1504,9 @@ components:
           description: Maps from solver name to object describing that solver's settlement.
           items:
             $ref: "#/components/schemas/SolverSettlement"
+        isWinner:
+          type: boolean
+          description: whether the solution is a winner or not
     SolverSettlement:
       type: object
       properties: