minimal-rollup/src/protocol/ICheckpointTracker.sol at 892c287c7deda58367a6622e844129035d093c64 · OpenZeppelin/minimal-rollup · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.28;

interface ICheckpointTracker {
    struct Checkpoint {
        uint256 publicationId;
        /// @dev A commitment can be anything that uniquely represents the state of the rollup
        /// @dev We recommend using the `keccak256(stateRoot, blockHash)` or similar to ensure both uniqueness and being
        /// able to verify messages across chains
        bytes32 commitment;
        /// @dev The cumulative number of delayed publications up to this checkpoint (since genesis)
        /// @dev This enables computing the delayed publications between two checkpoints
        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
    event CommitmentSaved(uint256 indexed publicationId, bytes32 commitment);

    /// @notice Emitted when ProverManager is updated
    /// @param proverManager The address of the ProverManager contract
    event ProverManagerUpdated(address indexed proverManager);

    /// @return _ The last proven publication ID
    function provenPublicationId() external view returns (uint256);

    /// @notice Updates the address of the ProverManager contract
    /// @param _proverManager The address of the ProverManager contract
    function updateProverManager(address _proverManager) external;

    /// @notice Verifies a transition between two checkpoints. Update the latest `provenCheckpoint` if possible
    /// @param start The initial checkpoint before the transition
    /// @param end The final checkpoint after the transition
    /// @param proof Arbitrary data passed to the `verifier` contract to confirm the transition validity
    /// @return _ The number of new publications that were proven. Note this may be lower than end.publicationId -
    /// start.publicationId because this proof may overlap with some proven checkpoints.
    /// @return _ The number of new delayed publications that were proven.
    function proveTransition(Checkpoint calldata start, Checkpoint calldata end, bytes calldata proof)
        external
        returns (uint256, uint256);
}