Minor Cleanup (#151)

Author: LeoPatOZ

offchain/sample_deposit_proof.rs

@@ -64,8 +64,8 @@ pub struct DepositSpecification {
 
 fn deposit_specification() -> Vec<DepositSpecification> {
     // This is an address on the destination chain, so it seems natural to use one generated there
-    // In this case, the CrossChainDepositExists.sol test case defines _randomAddress("recipient");
-    let recipient = "0x99A270Be1AA5E97633177041859aEEB9a0670fAa";
+    // In this case, the CrossChainDepositExists.sol test case defines makeAddr("recipient");
+    let recipient = "0x006217c47ffA5Eb3F3c92247ffFE22AD998242c5";
     // Use both zero and non-zero amounts (in this case 4 ether)
     let amounts = vec![0_u128, 4000000000000000000_u128];
     // Use different calldata to try different functions and inputs

src/libs/LibProvingPeriod.sol

@@ -39,13 +39,16 @@ library LibProvingPeriod {
         bool pastDeadline;
     }
 
+    /// @dev Prover Address cannot be zero
+    error ZeroProverAddress();
+
     /// @dev Initializes the period with the given parameters.
     /// @dev The _end_ and _deadline_ default to zero. The _pastDeadline_ flag defaults to false.
     /// @dev This can be called multiple times to set the latest bid while the auction is ongoing.
     function init(Period storage period, address prover, uint96 fee, uint16 delayedFeePercentage, uint96 stake)
         internal
     {
-        require(prover != address(0), "Prover cannot be zero address");
+        require(prover != address(0), ZeroProverAddress());
         period.prover = prover;
         period.fee = fee;
         period.delayedFeePercentage = delayedFeePercentage;

src/protocol/BaseProverManager.sol

@@ -80,6 +80,9 @@ abstract contract BaseProverManager is IProposerFees, IProverManager, BalanceAcc
     /// @dev Current period is not vacant
     error NoProvingVacancy();
 
+    /// @dev The provided address is zero
+    error ZeroAddress();
+
     /// @dev Initializes the contract state and deposits the initial prover's liveness bond.
     /// The constructor also calls `_claimProvingVacancy`. Publications will actually start in period 1.
     /// @param _inbox The address of the inbox contract
@@ -94,9 +97,9 @@ abstract contract BaseProverManager is IProposerFees, IProverManager, BalanceAcc
         uint96 _initialFee,
         uint256 _initialDeposit
     ) {
-        require(_inbox != address(0), "Inbox address cannot be 0");
-        require(_checkpointTracker != address(0), "Checkpoint tracker address cannot be 0");
-        require(_initialProver != address(0), "Initial prover address cannot be 0");
+        require(_inbox != address(0), ZeroAddress());
+        require(_checkpointTracker != address(0), ZeroAddress());
+        require(_initialProver != address(0), ZeroAddress());
 
         inbox = IInbox(_inbox);
         checkpointTracker = ICheckpointTracker(_checkpointTracker);

src/protocol/CheckpointTracker.sol

@@ -25,7 +25,7 @@ contract CheckpointTracker is ICheckpointTracker {
     /// @param _commitmentStore contract responsible storing historical commitments
     constructor(bytes32 _genesis, address _inbox, address _verifier, address _proverManager, address _commitmentStore) {
         // set the genesis checkpoint commitment of the rollup - genesis is trusted to be correct
-        require(_genesis != 0, "genesis checkpoint commitment cannot be 0");
+        require(_genesis != 0, ZeroGenesisCommitment());
         inbox = IInbox(_inbox);
         uint256 latestPublicationId = inbox.getNextPublicationId() - 1;
 
@@ -44,25 +44,26 @@ contract CheckpointTracker is ICheckpointTracker {
         external
         returns (uint256 numPublications, uint256 numDelayedPublications)
     {
+        require(proverManager == address(0) || msg.sender == proverManager, OnlyProverManager());
+
+        require(start.commitment != 0, ZeroStartCommitment());
+        require(end.commitment != 0, ZeroEndCommitment());
         require(
-            proverManager == address(0) || msg.sender == proverManager, "Only the prover manager can call this function"
+            start.publicationId <= provenPublicationId,
+            InvalidStartPublication(start.publicationId, provenPublicationId)
         );
 
-        require(start.commitment != 0, "Start checkpoint commitment cannot be 0");
-        require(end.commitment != 0, "End checkpoint commitment cannot be 0");
-        require(start.publicationId <= provenPublicationId, "Start publication must precede latest proven checkpoint");
-
         // Only count publications that have not been proven yet
         numPublications = end.publicationId - provenPublicationId;
         numDelayedPublications = end.totalDelayedPublications - _totalDelayedPublications;
         require(
             numDelayedPublications <= numPublications,
-            "Number of delayed publications cannot be greater than the total number of publications"
+            ExcessiveDelayedPublications(numDelayedPublications, numPublications)
         );
 
         bytes32 startPublicationHash = inbox.getPublicationHash(start.publicationId);
         bytes32 endPublicationHash = inbox.getPublicationHash(end.publicationId);
-        require(endPublicationHash != 0, "End publication does not exist");
+        require(endPublicationHash != 0, EndPublicationNotFound());
 
         verifier.verifyProof(
             startPublicationHash,

src/protocol/ERC20ProverManager.sol

@@ -1,3 +1,4 @@
+///SPDX-License-Identifier: MIT
 pragma solidity ^0.8.28;
 
 import {BaseProverManager} from "./BaseProverManager.sol";
@@ -15,6 +16,12 @@ contract ERC20ProverManager is BaseProverManager, IERC20Depositor {
 
     IERC20 public immutable token;
 
+    /// @param _inbox Address of the inbox contract
+    /// @param _checkpointTracker Address of the checkpoint tracker contract
+    /// @param _initialProver Address of the initial prover who will provide the bond
+    /// @param _initialFee Initial fee amount
+    /// @param _token Address of the ERC20 token used for bonds and fees
+    /// @param _initialDeposit Initial deposit amount that must cover the liveness bond
     constructor(
         address _inbox,
         address _checkpointTracker,
@@ -23,13 +30,9 @@ contract ERC20ProverManager is BaseProverManager, IERC20Depositor {
         address _token,
         uint256 _initialDeposit
     ) BaseProverManager(_inbox, _checkpointTracker, _initialProver, _initialFee, _initialDeposit) {
-        require(_token != address(0), "Token address cannot be 0");
-        require(
-            _initialDeposit >= _livenessBond(), "Initial deposit must be greater than or equal to the liveness bond"
-        );
-
+        require(_token != address(0), ZeroTokenAddress());
+        require(_initialDeposit >= _livenessBond(), InsufficientInitialDeposit(_initialDeposit, _livenessBond()));
         token = IERC20(_token);
-
         // Deposit the amount of funds needed for the liveness bond from the `_initialProver`
         token.safeTransferFrom(_initialProver, address(this), _initialDeposit);
     }

src/protocol/ETHBridge.sol

@@ -25,11 +25,13 @@ contract ETHBridge is IETHBridge, ReentrancyGuardTransient {
     /// WARN: This address has no significance (and may be untrustworthy) on this chain.
     address public immutable counterpart;
 
+    /// @param _signalService Address of the signal service contract
+    /// @param _trustedCommitmentPublisher Address of the trusted commitment publisher
+    /// @param _counterpart Address of the counterpart signal contract
     constructor(address _signalService, address _trustedCommitmentPublisher, address _counterpart) {
-        require(_signalService != address(0), "Empty signal service");
-        require(_trustedCommitmentPublisher != address(0), "Empty trusted publisher");
-        require(_counterpart != address(0), "Empty counterpart");
-
+        require(_signalService != address(0), EmptySignalService());
+        require(_trustedCommitmentPublisher != address(0), EmptyTrustedPublisher());
+        require(_counterpart != address(0), EmptyCounterpart());
         signalService = ISignalService(_signalService);
         trustedCommitmentPublisher = _trustedCommitmentPublisher;
         counterpart = _counterpart;

src/protocol/ETHProverManager.sol

@@ -8,14 +8,15 @@ import {IETHDepositor} from "./IProverManager.sol";
 /// @notice Implementation of the `BaseProverManager` contract that uses ETH for bids, stake and paying for publication
 /// fees.
 contract ETHProverManager is BaseProverManager, IETHDepositor {
+    /// @param _inbox Address of the inbox contract
+    /// @param _checkpointTracker Address of the checkpoint tracker contract
+    /// @param _initialProver Address of the initial prover who will provide the bond
+    /// @param _initialFee Initial fee amount
     constructor(address _inbox, address _checkpointTracker, address _initialProver, uint96 _initialFee)
         payable
         BaseProverManager(_inbox, _checkpointTracker, _initialProver, _initialFee, msg.value)
     {
-        require(
-            msg.value >= _livenessBond(),
-            "The amount of ETH deposited must be greater than or equal to the livenessBond"
-        );
+        require(msg.value >= _livenessBond(), InsufficientETHDeposit(msg.value, _livenessBond()));
     }
 
     /// @notice Receive ETH transfers and deposit them to the sender's balance
@@ -36,6 +37,6 @@ contract ETHProverManager is BaseProverManager, IETHDepositor {
         assembly ("memory-safe") {
             ok := call(gas(), to, amount, 0, 0, 0, 0)
         }
-        require(ok, "Withdraw failed");
+        require(ok, WithdrawFailed());
     }
 }

src/protocol/ICheckpointTracker.sol

@@ -13,6 +13,31 @@ interface ICheckpointTracker {
         uint256 totalDelayedPublications;
     }
 
+    /// @dev Genesis checkpoint commitment cannot be zero
+    error ZeroGenesisCommitment();
+
+    /// @dev Only the prover manager can call this function
+    error OnlyProverManager();
+
+    /// @dev Start checkpoint commitment cannot be zero
+    error ZeroStartCommitment();
+
+    /// @dev End checkpoint commitment cannot be zero
+    error ZeroEndCommitment();
+
+    /// @dev Start publication must precede latest proven checkpoint
+    /// @param startPublicationId The provided start publication ID
+    /// @param latestProvenId The latest proven publication ID
+    error InvalidStartPublication(uint256 startPublicationId, uint256 latestProvenId);
+
+    /// @dev Number of delayed publications exceeds total publications
+    /// @param delayedCount The number of delayed publications
+    /// @param totalCount The total number of publications
+    error ExcessiveDelayedPublications(uint256 delayedCount, uint256 totalCount);
+
+    /// @dev End publication does not exist
+    error EndPublicationNotFound();
+
     /// @notice Emitted when the latest commitment is saved
     /// @param publicationId the publication ID of the latest proven checkpoint
     /// @param commitment the commitment of the latest proven checkpoint

src/protocol/IDelayedInclusionStore.sol

@@ -10,6 +10,9 @@ interface IDelayedInclusionStore {
     /// @param inclusionsList list of inclusions
     event DelayedInclusionProcessed(Inclusion[] inclusionsList);
 
+    /// @dev Blob ref registry address cannot be zero
+    error ZeroBlobRefRegistry();
+
     /// @notice Register a delayed publication for later inclusion
     /// @param blobIndices An array of blob indices to be registered where the delayed publications are included
     function publishDelayed(uint256[] memory blobIndices) external;

src/protocol/IETHBridge.sol

@@ -40,6 +40,15 @@ interface IETHBridge {
     /// @param data The calldata sent to the claimee
     event DepositCancelled(bytes32 indexed id, address claimee, bytes data);
 
+    /// @dev Signal service address cannot be zero
+    error EmptySignalService();
+
+    /// @dev Trusted publisher address cannot be zero
+    error EmptyTrustedPublisher();
+
+    /// @dev Counterpart address cannot be zero
+    error EmptyCounterpart();
+
     /// @dev Failed to call the receiver with value.
     error FailedClaim();