Skip to content

Commit

Permalink
Merge pull request #95 from omahs/patch-2
Browse files Browse the repository at this point in the history
Fix: typos
  • Loading branch information
invocamanman authored Mar 16, 2023
2 parents d1cba89 + 29d11c1 commit 771ed35
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Private keys and mnemonics contained in this repository are used for internal te
- `PolygonZkEVMBridge.sol`: transfer assets between chains
- `PolygonZkEVMGlobalExitRoot.sol`: manage global exit root in L1
- `PolygonZkEVMGlobalExitRootL2.sol`: manage global exit root in L2
- `PolygonZkEVM.sol`: consensus algorithm used by polyhon hermez zkevm
- `PolygonZkEVM.sol`: consensus algorithm used by polygon hermez zkevm
- `docs`: specs and useful links
- `test`: contracts tests

Expand Down Expand Up @@ -82,7 +82,7 @@ Polygon `zkevm-contracts` was developed by Polygon. While we plan to adopt an op

## Note

In order to test, the following private keys are being used. This keys are not meant to be used in any production environment:
In order to test, the following private keys are being used. These keys are not meant to be used in any production environment:

- private key: `0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80`
- address:`0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266`
Expand Down
28 changes: 14 additions & 14 deletions contracts/PolygonZkEVM.sol
Original file line number Diff line number Diff line change
Expand Up @@ -280,37 +280,37 @@ contract PolygonZkEVM is
);

/**
* @dev Emitted when the admin update the trusted sequencer address
* @dev Emitted when the admin updates the trusted sequencer address
*/
event SetTrustedSequencer(address newTrustedSequencer);

/**
* @dev Emitted when the admin update the sequencer URL
* @dev Emitted when the admin updates the sequencer URL
*/
event SetTrustedSequencerURL(string newTrustedSequencerURL);

/**
* @dev Emitted when the admin update the trusted aggregator timeout
* @dev Emitted when the admin updates the trusted aggregator timeout
*/
event SetTrustedAggregatorTimeout(uint64 newTrustedAggregatorTimeout);

/**
* @dev Emitted when the admin update the pending state timeout
* @dev Emitted when the admin updates the pending state timeout
*/
event SetPendingStateTimeout(uint64 newPendingStateTimeout);

/**
* @dev Emitted when the admin update the trusted aggregator address
* @dev Emitted when the admin updates the trusted aggregator address
*/
event SetTrustedAggregator(address newTrustedAggregator);

/**
* @dev Emitted when the admin update the multiplier batch fee
* @dev Emitted when the admin updates the multiplier batch fee
*/
event SetMultiplierBatchFee(uint16 newMultiplierBatchFee);

/**
* @dev Emitted when the admin update the verify batch timeout
* @dev Emitted when the admin updates the verify batch timeout
*/
event SetVerifyBatchTimeTarget(uint64 newVerifyBatchTimeTarget);

Expand Down Expand Up @@ -900,8 +900,8 @@ contract PolygonZkEVM is
}

/**
* @notice Function to update the batch fee based on the new verfied batches
* The batch fee will not be updated when the trusted aggregator verify batches
* @notice Function to update the batch fee based on the new verified batches
* The batch fee will not be updated when the trusted aggregator verifies batches
* @param newLastVerifiedBatch New last verified batch
*/
function _updateBatchFee(uint64 newLastVerifiedBatch) internal {
Expand Down Expand Up @@ -1326,7 +1326,7 @@ contract PolygonZkEVM is

/**
* @notice Allows the trusted aggregator to override the pending state
* if its possible to prove a different state root given the same batches
* if it's possible to prove a different state root given the same batches
* @param initPendingStateNum Init pending state, 0 if consolidated state is used
* @param finalPendingStateNum Final pending state, that will be used to compare with the newStateRoot
* @param initNumBatch Batch which the aggregator starts the verification
Expand Down Expand Up @@ -1412,7 +1412,7 @@ contract PolygonZkEVM is
}

/**
* @notice Internal function that prove a different state root given the same batches to verify
* @notice Internal function that proves a different state root given the same batches to verify
* @param initPendingStateNum Init pending state, 0 if consolidated state is used
* @param finalPendingStateNum Final pending state, that will be used to compare with the newStateRoot
* @param initNumBatch Batch which the aggregator starts the verification
Expand Down Expand Up @@ -1511,7 +1511,7 @@ contract PolygonZkEVM is
}

/**
* @notice Function to activate emergency state, which also enable the emergency mode on both PolygonZkEVM and PolygonZkEVMBridge contracts
* @notice Function to activate emergency state, which also enables the emergency mode on both PolygonZkEVM and PolygonZkEVMBridge contracts
* If not called by the owner must be provided a batcnNum that does not have been aggregated in a _HALT_AGGREGATION_TIMEOUT period
* @param sequencedBatchNum Sequenced batch number that has not been aggreagated in _HALT_AGGREGATION_TIMEOUT
*/
Expand Down Expand Up @@ -1591,7 +1591,7 @@ contract PolygonZkEVM is

/**
* @notice Returns a boolean that indicates if the pendingStateNum is or not consolidable
* Note that his function do not check if the pending state currently exist, or if it's consolidated already
* Note that his function does not check if the pending state currently exists, or if it's consolidated already
*/
function isPendingStateConsolidable(
uint64 pendingStateNum
Expand Down Expand Up @@ -1619,7 +1619,7 @@ contract PolygonZkEVM is

/**
* @notice Function to calculate the input snark bytes
* @param initNumBatch Batch which the aggregator starts teh verification
* @param initNumBatch Batch which the aggregator starts the verification
* @param finalNewBatch Last batch aggregator intends to verify
* @param newLocalExitRoot New local exit root once the batch is processed
* @param oldStateRoot State root before batch is processed
Expand Down
2 changes: 1 addition & 1 deletion contracts/PolygonZkEVMGlobalExitRoot.sol
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ contract PolygonZkEVMGlobalExitRoot is IPolygonZkEVMGlobalExitRoot {
mapping(bytes32 => uint256) public globalExitRootMap;

/**
* @dev Emitted when the the global exit root is updated
* @dev Emitted when the global exit root is updated
*/
event UpdateGlobalExitRoot(
bytes32 indexed mainnetExitRoot,
Expand Down

0 comments on commit 771ed35

Please sign in to comment.