perf(provenPeriods): bitmap (#258)

Reviewer @rvagg @Kubuxu
Closes #257
This should reduce the proof storage growth by a factor of 256.
If the proving period is 1 day, and the deal lasts 1 year, this mapping
will use 2 slots instead of 356.
#### Changes
* Change provenPeriods to bitmap

Author: wjmelements

service_contracts/foundry.toml

@@ -27,6 +27,7 @@ fs_permissions = [{ access = "read", path = "./test" }]
 [lint]
 exclude_lints = [
     "asm-keccak256",
+    "incorrect-shift",
     "mixed-case-function",
     "mixed-case-variable",
     "pascal-case-struct",

service_contracts/src/FilecoinWarmStorageService.sol

@@ -231,8 +231,8 @@ contract FilecoinWarmStorageService is
     // Commission rate
     uint256 public serviceCommissionBps;
 
-    // Track which proving periods have valid proofs
-    mapping(uint256 dataSetId => mapping(uint256 periodId => bool)) private provenPeriods;
+    // Track which proving periods have valid proofs with bitmap
+    mapping(uint256 dataSetId => mapping(uint256 periodId => uint256)) private provenPeriods;
     // Track when proving was first activated for each data set
     mapping(uint256 dataSetId => uint256) private provingActivationEpoch;
 
@@ -818,7 +818,7 @@ contract FilecoinWarmStorageService is
         }
         provenThisPeriod[dataSetId] = true;
         uint256 currentPeriod = getProvingPeriodForEpoch(dataSetId, block.number);
-        provenPeriods[dataSetId][currentPeriod] = true;
+        provenPeriods[dataSetId][currentPeriod >> 8] |= 1 << (currentPeriod & 255);
     }
 
     // nextProvingPeriod checks for unsubmitted proof in which case it emits a fault event
@@ -893,12 +893,12 @@ contract FilecoinWarmStorageService is
         }
 
         // Record the status of the current/previous proving period that's ending
-        if (provingDeadlines[dataSetId] != NO_PROVING_DEADLINE) {
+        if (provingDeadlines[dataSetId] != NO_PROVING_DEADLINE && provenThisPeriod[dataSetId]) {
             // Determine the period ID that just completed
             uint256 completedPeriodId = getProvingPeriodForEpoch(dataSetId, provingDeadlines[dataSetId] - 1);
 
             // Record whether this period was proven
-            provenPeriods[dataSetId][completedPeriodId] = provenThisPeriod[dataSetId];
+            provenPeriods[dataSetId][completedPeriodId >> 8] |= 1 << (completedPeriodId & 255);
         }
 
         provingDeadlines[dataSetId] = nextDeadline;
@@ -1190,8 +1190,8 @@ contract FilecoinWarmStorageService is
             return provenThisPeriod[dataSetId];
         }
 
-        // For past periods, check the provenPeriods mapping
-        return provenPeriods[dataSetId][periodId];
+        // For past periods, check the provenPeriods bitmapping
+        return 0 != provenPeriods[dataSetId][periodId >> 8] & (1 << (periodId & 255));
     }
 
     function max(uint256 a, uint256 b) internal pure returns (uint256) {

service_contracts/src/lib/FilecoinWarmStorageServiceStateInternalLibrary.sol

@@ -148,9 +148,13 @@ library FilecoinWarmStorageServiceStateInternalLibrary {
         view
         returns (bool)
     {
-        return service.extsload(
-            keccak256(abi.encode(periodId, keccak256(abi.encode(dataSetId, StorageLayout.PROVEN_PERIODS_SLOT))))
-        ) != bytes32(0);
+        return uint256(
+            service.extsload(
+                keccak256(
+                    abi.encode(periodId >> 8, keccak256(abi.encode(dataSetId, StorageLayout.PROVEN_PERIODS_SLOT)))
+                )
+            )
+        ) & (1 << (periodId & 255)) != 0;
     }
 
     function provingActivationEpoch(FilecoinWarmStorageService service, uint256 dataSetId)

service_contracts/src/lib/FilecoinWarmStorageServiceStateLibrary.sol

@@ -144,9 +144,13 @@ library FilecoinWarmStorageServiceStateLibrary {
         view
         returns (bool)
     {
-        return service.extsload(
-            keccak256(abi.encode(periodId, keccak256(abi.encode(dataSetId, StorageLayout.PROVEN_PERIODS_SLOT))))
-        ) != bytes32(0);
+        return uint256(
+            service.extsload(
+                keccak256(
+                    abi.encode(periodId >> 8, keccak256(abi.encode(dataSetId, StorageLayout.PROVEN_PERIODS_SLOT)))
+                )
+            )
+        ) & (1 << (periodId & 255)) != 0;
     }
 
     function provingActivationEpoch(FilecoinWarmStorageService service, uint256 dataSetId)

service_contracts/test/FilecoinWarmStorageService.t.sol

@@ -9,7 +9,7 @@ import {Cids} from "@pdp/Cids.sol";
 import {MyERC1967Proxy} from "@pdp/ERC1967Proxy.sol";
 import {SessionKeyRegistry} from "@session-key-registry/SessionKeyRegistry.sol";
 
-import {FilecoinWarmStorageService} from "../src/FilecoinWarmStorageService.sol";
+import {CHALLENGES_PER_PROOF, FilecoinWarmStorageService} from "../src/FilecoinWarmStorageService.sol";
 import {FilecoinWarmStorageServiceStateView} from "../src/FilecoinWarmStorageServiceStateView.sol";
 import {Payments} from "@fws-payments/Payments.sol";
 import {MockERC20, MockPDPVerifier} from "./mocks/SharedMocks.sol";
@@ -1168,6 +1168,36 @@ contract FilecoinWarmStorageServiceTest is Test {
         assertEq(dataSet.payee, sp1, "Payee should remain unchanged");
     }
 
+    function testProvenPeriods() public {
+        uint256 testDataSetId = createDataSetForServiceProviderTest(sp1, client, "Test Data Set");
+        for (uint256 i = 0; i < 2049; i++) {
+            assertFalse(viewContract.provenPeriods(testDataSetId, i));
+        }
+        (
+            uint64 maxProvingPeriod,
+            uint256 challengeWindowSize,
+            uint256 challengesPerProof,
+            uint256 initChallengeWindowStart
+        ) = viewContract.getPDPConfig();
+        vm.startPrank(address(mockPDPVerifier));
+        pdpServiceWithPayments.nextProvingPeriod(testDataSetId, vm.getBlockNumber() + maxProvingPeriod, 100, "");
+        vm.roll(vm.getBlockNumber() + maxProvingPeriod - challengeWindowSize);
+        for (uint256 i = 0; i < 2049; i++) {
+            assertFalse(viewContract.provenPeriods(testDataSetId, i));
+            pdpServiceWithPayments.possessionProven(testDataSetId, 100, 12345, CHALLENGES_PER_PROOF);
+            assertTrue(viewContract.provenPeriods(testDataSetId, i));
+
+            vm.roll(vm.getBlockNumber() + challengeWindowSize);
+            pdpServiceWithPayments.nextProvingPeriod(testDataSetId, vm.getBlockNumber() + maxProvingPeriod, 100, "");
+            vm.roll(vm.getBlockNumber() + maxProvingPeriod - challengeWindowSize);
+        }
+        vm.stopPrank();
+
+        for (uint256 i = 0; i < 2049; i++) {
+            assertTrue(viewContract.provenPeriods(testDataSetId, i));
+        }
+    }
+
     // Data Set Payment Termination Tests
 
     function testTerminateServiceLifecycle() public {