From b8851317bc684e1922633dd55e7e3a21fd11149f Mon Sep 17 00:00:00 2001
From: Jean-Paul Calderone <exarkun@twistedmatrix.com>
Date: Wed, 17 Nov 2021 18:43:54 -0500
Subject: [PATCH] make the comment about slot leases more accurate

---
 src/_zkapauthorizer/_storage_server.py | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/src/_zkapauthorizer/_storage_server.py b/src/_zkapauthorizer/_storage_server.py
index f737e74..5352d0a 100644
--- a/src/_zkapauthorizer/_storage_server.py
+++ b/src/_zkapauthorizer/_storage_server.py
@@ -387,8 +387,17 @@ class ZKAPAuthorizerStorageServer(Referenceable):
             renew_leases=False,
         )
 
-        # Add the lease that we charged the client for: leases on all written
-        # shares without an unexpired lease.
+        # Add the leases that we charged the client for.  This includes:
+        #
+        #  - leases on newly created shares
+        #
+        #  - leases on existing, modified shares without an unexpired lease
+        #
+        # Note it does not include existing shares that grew enough to be more
+        # expensive.  The operation was required to pay the full price
+        # difference but this only grants storage for the remainder of the
+        # existing lease period.  This results in the client being overcharged
+        # somewhat.
         add_leases_for_writev(self._original, storage_index, secrets, tw_vectors, now)
 
         # Propagate the result of the operation.
-- 
GitLab