[Easy] Add minimal documentation on Coincidence of Wants queries (#131)

* add minimal documentation on CoW queries * complete docstring of cow query
cowprotocol · Feb 1, 2025 · 0fe990f · 0fe990f
1 parent dd87627
commit 0fe990f
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/cowprotocol/coincidence_of_wants/README.md b/cowprotocol/coincidence_of_wants/README.md
@@ -0,0 +1,17 @@
+# Coincidence of Wants
+
+The queries in this folder are used to compute quantitative measures of Coincidence of Wants (CoW).
+Results are used for solver bounties and general monitoring.
+
+The approach to measuring CoWs is based on a [Master's Thesis by Vigan Lladrovci](https://wwwmatthes.in.tum.de/pages/y9xcjv094zhn/Master-s-Thesis-Vigan-Lladrovci).
+
+## Query structure
+
+![Structure of CoW query](cow.svg)
+
+The figure was generated using https://app.diagrams.net/.
+
+## Notes
+
+- This measure of CoWs cannot detect all benefits of batching.
+- Slippage is treated as if there had been additional AMM interactions which lead to a settlement without slippage.
diff --git a/cowprotocol/coincidence_of_wants/cow.svg b/cowprotocol/coincidence_of_wants/cow.svg