docs: polishing and audit (#46)

* docs: mention `scaling_factor` * docs: remove misleading documentation * chore: remove unused code
curvefi · Nov 4, 2024 · 1bb64cf · 1bb64cf
1 parent cb0217e
commit 1bb64cf
Show file tree

Hide file tree

Showing 12 changed files with 3 additions and 489 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ $$\text{minimum weight} \leq \text{weight} \leq \text{fee splitter cap}$$
 
 - Upper bounded by whatever percentage cap the fee splitter has. (Controlled by the DAO)
 - Lower bounded by the `minimum_weight` parameter in the rewards handler. (Controlled by any `RATE_MANAGER` appointed by the DAO, or the DAO itself)
+- The weight can be adjusted using a `scaling_factor` if necessary. (Controlled by any `RATE_MANAGER` appointed by the DAO, or the DAO itself)
 
 
 Furthermore, it can be adjusted at any time by any `RATE_MANAGER` by calling the `set_distribution_time` function in the rewards' handler to prevent manipulation (i.e. MEV on the snapshots).
diff --git a/contracts/DepositLimitModule.vy b/contracts/DepositLimitModule.vy
diff --git a/contracts/StablecoinLens.vy b/contracts/StablecoinLens.vy
@@ -37,10 +37,8 @@ def _circulating_supply() -> uint256:
     @dev This function sacrifices some gas to fetch peg keepers from a unique source
     of truth to avoid having to manually maintain multiple lists across several
     contracts. For this reason we read the list of peg keepers contained in the
-    monetary policy returned by a controller in the factory. factory -> weth
-    controller -> monetary policy -> peg keepers This function is not exposed as
-    external as it can be easily manipulated and should not be used by third party
-    contracts.
+    monetary policy returned by a controller in the factory.
+    factory -> weth controller -> monetary policy -> peg keepers
     """
 
     circulating_supply: uint256 = 0

diff --git a/tests/unitary/deposit_limit_module/test_available_deposit_limit.py b/tests/unitary/deposit_limit_module/test_available_deposit_limit.py
diff --git a/tests/unitary/deposit_limit_module/test_internal_set_admin.py b/tests/unitary/deposit_limit_module/test_internal_set_admin.py
diff --git a/tests/unitary/deposit_limit_module/test_internal_set_controller.py b/tests/unitary/deposit_limit_module/test_internal_set_controller.py
diff --git a/tests/unitary/deposit_limit_module/test_internal_set_deposit_limit.py b/tests/unitary/deposit_limit_module/test_internal_set_deposit_limit.py
diff --git a/tests/unitary/deposit_limit_module/test_internal_set_deposits_paused.py b/tests/unitary/deposit_limit_module/test_internal_set_deposits_paused.py