Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

N-07 documentation tweaks #12

Merged
merged 2 commits into from Nov 17, 2023
Merged

N-07 documentation tweaks #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5da385d
documentation tweaks
thedarkjester Aug 23, 2023
c7633b3
Merge branch 'main' into n-07/documentation
thedarkjester Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion contracts/ZkEvmV2.sol
View file
Open in desktop
Expand Up @@ -134,7 +134,8 @@ contract ZkEvmV2 is IZkEvmV2, Initializable, AccessControlUpgradeable, L1Message
}

/**
* @notice Finalizes blocks with or without using a proof depending on _shouldProve
* @notice Finalizes blocks using a proof.
* @dev OPERATOR_ROLE is required to execute.
* @dev If the verifier based on proof type is not found, it reverts.
* @param _blocksData The full BlockData collection - block, transaction and log data.
* @param _proof The proof to be verified with the proof type verifier contract.
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IL1MessageManager.sol
View file
Open in desktop
Expand Up @@ -18,7 +18,7 @@ interface IL1MessageManager {
error MessageAlreadySent();

/**
* @dev Thrown when the message has already been claimed.
* @dev Thrown when the message has already been claimed or does not exist.
*/
error MessageDoesNotExistOrHasAlreadyBeenClaimed();

Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IL2MessageManager.sol
View file
Open in desktop
Expand Up @@ -18,7 +18,7 @@ interface IL2MessageManager {
error EmptyMessageHashesArray();

/**
* @dev Thrown when the message does not exist or has already been claimed.
* @dev Thrown when the message does not exist or has already been claimed or does not exist.
*/
error MessageDoesNotExistOrHasAlreadyBeenClaimed();

Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IMessageService.sol
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@ interface IMessageService {
error MessageSendingFailed(address destination);

/**
* @dev Thrown when the destination address reverts.
* @dev Thrown when the recipient address reverts.
*/
error FeePaymentFailed(address recipient);

Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/IRateLimiter.sol
View file
Open in desktop
Expand Up @@ -35,7 +35,7 @@ interface IRateLimiter {

/**
* @notice Resets the rate limit amount to the amount specified.
* @param _amount New message hashes.
* @param _amount sets the new limit amount.
*/
function resetRateLimitAmount(uint256 _amount) external;

Expand Down
18 changes: 9 additions & 9 deletions contracts/interfaces/IZkEvmV2.sol
View file
Open in desktop
Expand Up @@ -88,16 +88,16 @@ interface IZkEvmV2 {
function finalizeBlocksWithoutProof(BlockData[] calldata _calldata) external;

/**
* @notice Finalizes blocks without using a proof
* @dev OPERATOR_ROLE is required to execute
* @dev If the verifier based on proof type is not found, it defaults to the default verifier type
* @param _calldata The full BlockData collection - block, transaction and log data
* @param _proof The proof to verified with the proof type verifier contract
* @param _proofType The proof type to determine which verifier contract to use
* @param _parentStateRootHash The beginning roothash to start with
*/
* @notice Finalizes blocks using a proof.
* @dev OPERATOR_ROLE is required to execute.
* @dev If the verifier based on proof type is not found, it reverts.
* @param _blocksData The full BlockData collection - block, transaction and log data.
* @param _proof The proof to be verified with the proof type verifier contract.
* @param _proofType The proof type to determine which verifier contract to use.
* @param _parentStateRootHash The starting roothash for the last known block.
**/
function finalizeBlocks(
BlockData[] calldata _calldata,
BlockData[] calldata _blocksData,
bytes calldata _proof,
uint256 _proofType,
bytes32 _parentStateRootHash
Expand Down
2 changes: 0 additions & 2 deletions contracts/messageService/l2/L2MessageManager.sol
View file
Open in desktop
Expand Up @@ -15,8 +15,6 @@ abstract contract L2MessageManager is Initializable, PauseManager, IL2MessageMan
uint8 public constant INBOX_STATUS_RECEIVED = 1;
uint8 public constant INBOX_STATUS_CLAIMED = 2;

/// @dev There is a uint232 worth of storage layout here

bytes32 public constant L1_L2_MESSAGE_SETTER_ROLE = keccak256("L1_L2_MESSAGE_SETTER_ROLE");

/**
Expand Down