From e1a697f9a3c0cee59fe6a12ba59978ac42fe5818 Mon Sep 17 00:00:00 2001 From: wgyt Date: Wed, 9 Apr 2025 17:58:37 +0800 Subject: [PATCH] chore: fix typos --- contracts/PolygonZkEVM.sol | 8 ++++---- contracts/v2/PolygonRollupManager.sol | 10 +++++----- contracts/v2/lib/PolygonConsensusBase.sol | 2 +- contracts/v2/lib/PolygonRollupBaseEtrog.sol | 4 ++-- .../PolygonRollupBaseEtrogPrevious.sol | 4 ++-- .../previousVersions/PolygonRollupManagerPrevious.sol | 4 ++-- .../PolygonRollupManagerPreviousV1toV2.sol | 4 ++-- docs/PolygonZkEVM.md | 8 ++++---- docs/v2/PolygonRollupManager.md | 10 +++++----- docs/v2/lib/PolygonConsensusBase.md | 2 +- docs/v2/lib/PolygonRollupBaseEtrog.md | 4 ++-- .../previousVersions/PolygonRollupBaseEtrogPrevious.md | 4 ++-- .../previousVersions/PolygonRollupManagerPrevious.md | 4 ++-- .../PolygonRollupManagerPreviousV1toV2.md | 4 ++-- 14 files changed, 36 insertions(+), 36 deletions(-) diff --git a/contracts/PolygonZkEVM.sol b/contracts/PolygonZkEVM.sol index 4bc4a1826..f4b574d75 100644 --- a/contracts/PolygonZkEVM.sol +++ b/contracts/PolygonZkEVM.sol @@ -263,7 +263,7 @@ contract PolygonZkEVM is event SequenceForceBatches(uint64 indexed numBatch); /** - * @dev Emitted when a aggregator verifies batches + * @dev Emitted when an aggregator verifies batches */ event VerifyBatches( uint64 indexed numBatch, @@ -852,7 +852,7 @@ contract PolygonZkEVM is } /** - * @notice Allows to consolidate any pending state that has already exceed the pendingStateTimeout + * @notice Allows to consolidate any pending state that has already exceeded the pendingStateTimeout * Can be called by the trusted aggregator, which can consolidate any state without the timeout restrictions * @param pendingStateNum Pending state to consolidate */ @@ -872,7 +872,7 @@ contract PolygonZkEVM is } /** - * @notice Internal function to consolidate any pending state that has already exceed the pendingStateTimeout + * @notice Internal function to consolidate any pending state that has already exceeded the pendingStateTimeout * @param pendingStateNum Pending state to consolidate */ function _consolidatePendingState(uint64 pendingStateNum) internal { @@ -1310,7 +1310,7 @@ contract PolygonZkEVM is /** * @notice Starts the admin role transfer - * This is a two step process, the pending admin must accepted to finalize the process + * This is a two step process, the pending admin must accept to finalize the process * @param newPendingAdmin Address of the new pending admin */ function transferAdminRole(address newPendingAdmin) external onlyAdmin { diff --git a/contracts/v2/PolygonRollupManager.sol b/contracts/v2/PolygonRollupManager.sol index d854b593f..a9dacdd35 100644 --- a/contracts/v2/PolygonRollupManager.sol +++ b/contracts/v2/PolygonRollupManager.sol @@ -313,7 +313,7 @@ contract PolygonRollupManager is ); /** - * @dev Emitted when a a rolup type is obsoleted + * @dev Emitted when a rolup type is obsoleted */ event ObsoleteRollupType(uint32 indexed rollupTypeID); @@ -342,7 +342,7 @@ contract PolygonRollupManager is ); /** - * @dev Emitted when a rollup is udpated + * @dev Emitted when a rollup is updated */ event UpdateRollup( uint32 indexed rollupID, @@ -656,7 +656,7 @@ contract PolygonRollupManager is /** * @notice Upgrade an existing rollup from the rollup admin address - * This address is able to udpate the rollup with more restrictions that the _UPDATE_ROLLUP_ROLE + * This address is able to update the rollup with more restrictions that the _UPDATE_ROLLUP_ROLE * @param rollupContract Rollup consensus proxy address * @param newRollupTypeID New rolluptypeID to upgrade to */ @@ -1281,8 +1281,8 @@ contract PolygonRollupManager is /** * @notice Get batch fee - * This function is used instad of the automatic public view one, - * because in a future might change the behaviour and we will be able to mantain the interface + * This function is used instead of the automatic public view one, + * because in a future might change the behaviour and we will be able to maintain the interface */ function getBatchFee() public view returns (uint256) { return _batchFee; diff --git a/contracts/v2/lib/PolygonConsensusBase.sol b/contracts/v2/lib/PolygonConsensusBase.sol index 72284ac3e..5152dcdfa 100644 --- a/contracts/v2/lib/PolygonConsensusBase.sol +++ b/contracts/v2/lib/PolygonConsensusBase.sol @@ -200,7 +200,7 @@ abstract contract PolygonConsensusBase is /** * @notice Starts the admin role transfer - * This is a two step process, the pending admin must accepted to finalize the process + * This is a two step process, the pending admin must accept to finalize the process * @param newPendingAdmin Address of the new pending admin */ function transferAdminRole(address newPendingAdmin) external onlyAdmin { diff --git a/contracts/v2/lib/PolygonRollupBaseEtrog.sol b/contracts/v2/lib/PolygonRollupBaseEtrog.sol index 5700c94d1..fc896be78 100644 --- a/contracts/v2/lib/PolygonRollupBaseEtrog.sol +++ b/contracts/v2/lib/PolygonRollupBaseEtrog.sol @@ -165,7 +165,7 @@ abstract contract PolygonRollupBaseEtrog is ); /** - * @dev Emitted when a aggregator verifies batches + * @dev Emitted when an aggregator verifies batches */ event VerifyBatches( uint64 indexed numBatch, @@ -174,7 +174,7 @@ abstract contract PolygonRollupBaseEtrog is ); /** - * @dev Emitted when a aggregator verifies batches + * @dev Emitted when an aggregator verifies batches */ event RollbackBatches( uint64 indexed targetBatch, diff --git a/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol b/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol index 8728c2204..24dc6666a 100644 --- a/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol +++ b/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol @@ -227,7 +227,7 @@ abstract contract PolygonRollupBaseEtrogPrevious is ); /** - * @dev Emitted when a aggregator verifies batches + * @dev Emitted when an aggregator verifies batches */ event VerifyBatches( uint64 indexed numBatch, @@ -813,7 +813,7 @@ abstract contract PolygonRollupBaseEtrogPrevious is /** * @notice Starts the admin role transfer - * This is a two step process, the pending admin must accepted to finalize the process + * This is a two step process, the pending admin must accept to finalize the process * @param newPendingAdmin Address of the new pending admin */ function transferAdminRole(address newPendingAdmin) external onlyAdmin { diff --git a/contracts/v2/previousVersions/PolygonRollupManagerPrevious.sol b/contracts/v2/previousVersions/PolygonRollupManagerPrevious.sol index 2a498433b..19a0abd81 100644 --- a/contracts/v2/previousVersions/PolygonRollupManagerPrevious.sol +++ b/contracts/v2/previousVersions/PolygonRollupManagerPrevious.sol @@ -1142,7 +1142,7 @@ contract PolygonRollupManagerPrevious is } /** - * @notice Allows to consolidate any pending state that has already exceed the pendingStateTimeout + * @notice Allows to consolidate any pending state that has already exceeded the pendingStateTimeout * Can be called by the trusted aggregator, which can consolidate any state without the timeout restrictions * @param rollupID Rollup identifier * @param pendingStateNum Pending state to consolidate @@ -1167,7 +1167,7 @@ contract PolygonRollupManagerPrevious is } /** - * @notice Internal function to consolidate any pending state that has already exceed the pendingStateTimeout + * @notice Internal function to consolidate any pending state that has already exceeded the pendingStateTimeout * @param rollup Rollup data storage pointer * @param pendingStateNum Pending state to consolidate */ diff --git a/contracts/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.sol b/contracts/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.sol index 8126e419a..9eab9259e 100644 --- a/contracts/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.sol +++ b/contracts/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.sol @@ -1096,7 +1096,7 @@ contract PolygonRollupManagerPreviousV1toV2 is } /** - * @notice Allows to consolidate any pending state that has already exceed the pendingStateTimeout + * @notice Allows to consolidate any pending state that has already exceeded the pendingStateTimeout * Can be called by the trusted aggregator, which can consolidate any state without the timeout restrictions * @param rollupID Rollup identifier * @param pendingStateNum Pending state to consolidate @@ -1121,7 +1121,7 @@ contract PolygonRollupManagerPreviousV1toV2 is } /** - * @notice Internal function to consolidate any pending state that has already exceed the pendingStateTimeout + * @notice Internal function to consolidate any pending state that has already exceeded the pendingStateTimeout * @param rollup Rollup data storage pointer * @param pendingStateNum Pending state to consolidate */ diff --git a/docs/PolygonZkEVM.md b/docs/PolygonZkEVM.md index 748e23b83..dcce3f194 100644 --- a/docs/PolygonZkEVM.md +++ b/docs/PolygonZkEVM.md @@ -153,7 +153,7 @@ It tries to consolidate the first and the middle pending state in the queue uint64 pendingStateNum ) external ``` -Allows to consolidate any pending state that has already exceed the pendingStateTimeout +Allows to consolidate any pending state that has already exceeded the pendingStateTimeout Can be called by the trusted aggregator, which can consolidate any state without the timeout restrictions @@ -168,7 +168,7 @@ Can be called by the trusted aggregator, which can consolidate any state without uint64 pendingStateNum ) internal ``` -Internal function to consolidate any pending state that has already exceed the pendingStateTimeout +Internal function to consolidate any pending state that has already exceeded the pendingStateTimeout #### Parameters: @@ -359,7 +359,7 @@ This action is not reversible ) external ``` Starts the admin role transfer -This is a two step process, the pending admin must accepted to finalize the process +This is a two step process, the pending admin must accept to finalize the process #### Parameters: @@ -587,7 +587,7 @@ Emitted when forced batches are sequenced by not the trusted sequencer ) ``` -Emitted when a aggregator verifies batches +Emitted when an aggregator verifies batches ### VerifyBatchesTrustedAggregator ```solidity diff --git a/docs/v2/PolygonRollupManager.md b/docs/v2/PolygonRollupManager.md index 17d48c670..f30c30dca 100644 --- a/docs/v2/PolygonRollupManager.md +++ b/docs/v2/PolygonRollupManager.md @@ -133,7 +133,7 @@ note that this rollup does not follow any rollupType ) external ``` Upgrade an existing rollup from the rollup admin address -This address is able to udpate the rollup with more restrictions that the _UPDATE_ROLLUP_ROLE +This address is able to update the rollup with more restrictions that the _UPDATE_ROLLUP_ROLE #### Parameters: @@ -375,8 +375,8 @@ Function to calculate the reward to verify a single batch ) public returns (uint256) ``` Get batch fee -This function is used instad of the automatic public view one, -because in a future might change the behaviour and we will be able to mantain the interface +This function is used instead of the automatic public view one, +because in a future might change the behaviour and we will be able to maintain the interface @@ -568,7 +568,7 @@ Emitted when a new rollup type is added ) ``` -Emitted when a a rolup type is obsoleted +Emitted when a rolup type is obsoleted ### CreateNewRollup ```solidity @@ -592,7 +592,7 @@ Emitted when an existing rollup is added ) ``` -Emitted when a rollup is udpated +Emitted when a rollup is updated ### OnSequenceBatches ```solidity diff --git a/docs/v2/lib/PolygonConsensusBase.md b/docs/v2/lib/PolygonConsensusBase.md index e81bec15d..ed0504fc1 100644 --- a/docs/v2/lib/PolygonConsensusBase.md +++ b/docs/v2/lib/PolygonConsensusBase.md @@ -83,7 +83,7 @@ Allow the admin to set the trusted sequencer URL ) external ``` Starts the admin role transfer -This is a two step process, the pending admin must accepted to finalize the process +This is a two step process, the pending admin must accept to finalize the process #### Parameters: diff --git a/docs/v2/lib/PolygonRollupBaseEtrog.md b/docs/v2/lib/PolygonRollupBaseEtrog.md index d244e936c..90c2abf9c 100644 --- a/docs/v2/lib/PolygonRollupBaseEtrog.md +++ b/docs/v2/lib/PolygonRollupBaseEtrog.md @@ -250,7 +250,7 @@ Emitted when the contract is initialized, contain the first sequenced transactio ) ``` -Emitted when a aggregator verifies batches +Emitted when an aggregator verifies batches ### RollbackBatches ```solidity @@ -258,7 +258,7 @@ Emitted when a aggregator verifies batches ) ``` -Emitted when a aggregator verifies batches +Emitted when an aggregator verifies batches ### SetForceBatchTimeout ```solidity diff --git a/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md b/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md index 7863170d9..2ff8053c2 100644 --- a/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md +++ b/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md @@ -190,7 +190,7 @@ The new value can only be lower, except if emergency state is active ) external ``` Starts the admin role transfer -This is a two step process, the pending admin must accepted to finalize the process +This is a two step process, the pending admin must accept to finalize the process #### Parameters: @@ -284,7 +284,7 @@ Emitted when the contract is initialized, contain the first sequenced transactio ) ``` -Emitted when a aggregator verifies batches +Emitted when an aggregator verifies batches ### SetTrustedSequencer ```solidity diff --git a/docs/v2/previousVersions/PolygonRollupManagerPrevious.md b/docs/v2/previousVersions/PolygonRollupManagerPrevious.md index e4e702426..c4e3ba401 100644 --- a/docs/v2/previousVersions/PolygonRollupManagerPrevious.md +++ b/docs/v2/previousVersions/PolygonRollupManagerPrevious.md @@ -319,7 +319,7 @@ It tries to consolidate the first and the middle pending state in the queue uint64 pendingStateNum ) external ``` -Allows to consolidate any pending state that has already exceed the pendingStateTimeout +Allows to consolidate any pending state that has already exceeded the pendingStateTimeout Can be called by the trusted aggregator, which can consolidate any state without the timeout restrictions @@ -336,7 +336,7 @@ Can be called by the trusted aggregator, which can consolidate any state without uint64 pendingStateNum ) internal ``` -Internal function to consolidate any pending state that has already exceed the pendingStateTimeout +Internal function to consolidate any pending state that has already exceeded the pendingStateTimeout #### Parameters: diff --git a/docs/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.md b/docs/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.md index c3a659561..3ba3c2199 100644 --- a/docs/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.md +++ b/docs/v2/previousVersions/PolygonRollupManagerPreviousV1toV2.md @@ -301,7 +301,7 @@ It tries to consolidate the first and the middle pending state in the queue uint64 pendingStateNum ) external ``` -Allows to consolidate any pending state that has already exceed the pendingStateTimeout +Allows to consolidate any pending state that has already exceeded the pendingStateTimeout Can be called by the trusted aggregator, which can consolidate any state without the timeout restrictions @@ -318,7 +318,7 @@ Can be called by the trusted aggregator, which can consolidate any state without uint64 pendingStateNum ) internal ``` -Internal function to consolidate any pending state that has already exceed the pendingStateTimeout +Internal function to consolidate any pending state that has already exceeded the pendingStateTimeout #### Parameters: