From 023c0ea4a68e79dba85f0d94a7896bf83cbbda7f Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Tue, 14 Feb 2023 17:20:06 +0100 Subject: [PATCH 1/3] Fix: typo --- contracts/PolygonZkEVMGlobalExitRoot.sol | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contracts/PolygonZkEVMGlobalExitRoot.sol b/contracts/PolygonZkEVMGlobalExitRoot.sol index 2d61a1e..5b91d9e 100644 --- a/contracts/PolygonZkEVMGlobalExitRoot.sol +++ b/contracts/PolygonZkEVMGlobalExitRoot.sol @@ -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, From 0e79caa05a13c76f9127bf929251435624f26d47 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Tue, 14 Feb 2023 17:25:25 +0100 Subject: [PATCH 2/3] Fix: typos --- contracts/PolygonZkEVM.sol | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/contracts/PolygonZkEVM.sol b/contracts/PolygonZkEVM.sol index aea888b..360dfc7 100644 --- a/contracts/PolygonZkEVM.sol +++ b/contracts/PolygonZkEVM.sol @@ -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); @@ -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 { @@ -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 @@ -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 @@ -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 */ @@ -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 @@ -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 From 29d11c162771259dc07741c3168d5c33baccaa0c Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Tue, 14 Feb 2023 17:25:58 +0100 Subject: [PATCH 3/3] Fix: typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 388d6bd..fa6b546 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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`