Skip to content

Commit

Permalink
fix documentation mismatch
Browse files Browse the repository at this point in the history
  • Loading branch information
StanislavBreadless committed Jan 2, 2024
1 parent 2e0734b commit a320b9b
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ data from L2 and to prove that they were sent on L1 using only `l2ToL1log`. To s
this trick:

- One of the system contracts accepts an arbitrary length message and sends a fixed length message with parameters
`senderAddress == this`, `marker == true`, `key == msg.sender`, `value == keccak256(message)`.
`senderAddress == this`, `isService == true`, `key == msg.sender`, `value == keccak256(message)`.
- The contract on L1 accepts all sent messages and if the message came from this system contract it requires that the
preimage of `value` be provided.

Expand Down
2 changes: 1 addition & 1 deletion ethereum/contracts/governance/Governance.sol
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ contract Governance is IGovernance, Ownable2Step {
//////////////////////////////////////////////////////////////*/

/// @dev Cancel the scheduled operation.
/// @dev Both the owner and security council may cancel an operation.
/// @dev Only owner can call this function.
/// @param _id Proposal id value (see `hashOperation`)
function cancel(bytes32 _id) external onlyOwner {
require(isOperationPending(_id), "Operation must be pending");
Expand Down
4 changes: 2 additions & 2 deletions ethereum/contracts/upgrades/BaseZkSyncUpgrade.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ abstract contract BaseZkSyncUpgrade is Base {
/// @param bootloaderHash The hash of the new bootloader bytecode. If zero, it will not be updated.
/// @param defaultAccountHash The hash of the new default account bytecode. If zero, it will not be updated.
/// @param verifier The address of the new verifier. If zero, the verifier will not be updated.
/// @param verifierParams The new verifier params. If either of its fields is 0, the params will not be updated.
/// @param verifierParams The new verifier params. If all of its fields are 0, the params will not be updated.
/// @param l1ContractsUpgradeCalldata Custom calldata for L1 contracts upgrade, it may be interpreted differently
/// in each upgrade. Usually empty.
/// @param postUpgradeCalldata Custom calldata for post upgrade hook, it may be interpreted differently in each
Expand Down Expand Up @@ -135,7 +135,7 @@ abstract contract BaseZkSyncUpgrade is Base {

/// @notice Updates the verifier and the verifier params
/// @param _newVerifier The address of the new verifier. If 0, the verifier will not be updated.
/// @param _verifierParams The new verifier params. If either of the fields is 0, the params will not be updated.
/// @param _verifierParams The new verifier params. If all of the fields are 0, the params will not be updated.
function _upgradeVerifier(address _newVerifier, VerifierParams calldata _verifierParams) internal {
_setVerifier(IVerifier(_newVerifier));
_setVerifierParams(_verifierParams);
Expand Down
2 changes: 1 addition & 1 deletion ethereum/contracts/zksync/libraries/LibMap.sol
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ library LibMap {

/// @dev Updates the uint32 value at `_index` in `map`.
/// @param _map The Uint32Map instance containing the packed uint32 values.
/// @param _index The index of the uint32 value to retrieve.
/// @param _index The index of the uint32 value to set.
/// @param _value The new value at the specified index.
function set(Uint32Map storage _map, uint256 _index, uint32 _value) internal {
unchecked {
Expand Down
2 changes: 1 addition & 1 deletion zksync/contracts/L2ContractHelper.sol
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ pragma solidity 0.8.20;
* the first one is taken from the context, the other three are chosen by the sender.
* @dev To send a variable-length message we use this trick:
* - This system contract accepts an arbitrary length message and sends a fixed length message with
* parameters `senderAddress == this`, `marker == true`, `key == msg.sender`, `value == keccak256(message)`.
* parameters `senderAddress == this`, `isService == true`, `key == msg.sender`, `value == keccak256(message)`.
* - The contract on L1 accepts all sent messages and if the message came from this system contract
* it requires that the preimage of `value` be provided.
*/
Expand Down

0 comments on commit a320b9b

Please sign in to comment.