src/README.md

pysel · Nov 28, 2024 · 9c8254e · 9c8254e
1 parent cd75d22
commit 9c8254e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/README.md b/src/README.md
@@ -0,0 +1,7 @@
+# Contracts
+
+- `ClvrHook.sol`: The entrypoint contract for the CLVR ordering protocol.
+- `ClvrModel.sol`: The model that describes the rule by which swaps are ordered.
+- `ClvrLn.sol`: A small library for calculating the natural logarithm of a number times 1e18.
+- `ClvrSlashing.sol`: A contract that handles the slashing of schedulers that do not follow the protocol correctly.
+- `ClvrStake.sol`: A contract that handles the staking of schedulers.