From 73d2aaad80a6d7c01d4f2e596a09c2783e06c39d Mon Sep 17 00:00:00 2001 From: rootdiae Date: Fri, 25 Apr 2025 16:04:16 +0800 Subject: [PATCH] fix: typos --- contracts/v2/PolygonZkEVMGlobalExitRootV2.sol | 2 +- contracts/v2/consensus/validium/PolygonValidiumEtrog.sol | 4 ++-- contracts/v2/lib/PolygonRollupBaseEtrog.sol | 2 +- .../v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol | 2 +- .../v2/previousVersions/PolygonValidiumEtrogPrevious.sol | 4 ++-- contracts/v2/sovereignChains/BridgeL2SovereignChain.sol | 2 +- docs/v2/PolygonZkEVMGlobalExitRootV2.md | 2 +- docs/v2/consensus/validium/PolygonValidiumEtrog.md | 4 ++-- docs/v2/lib/PolygonRollupBaseEtrog.md | 2 +- docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md | 2 +- docs/v2/previousVersions/PolygonValidiumEtrogPrevious.md | 4 ++-- docs/v2/sovereignChains/BridgeL2SovereignChain.md | 2 +- tools/createSovereignGenesis/README.md | 4 ++-- tools/deployVerifier/README.md | 4 ++-- 14 files changed, 20 insertions(+), 20 deletions(-) diff --git a/contracts/v2/PolygonZkEVMGlobalExitRootV2.sol b/contracts/v2/PolygonZkEVMGlobalExitRootV2.sol index 5298249a7..c9884f8e4 100644 --- a/contracts/v2/PolygonZkEVMGlobalExitRootV2.sol +++ b/contracts/v2/PolygonZkEVMGlobalExitRootV2.sol @@ -61,7 +61,7 @@ contract PolygonZkEVMGlobalExitRootV2 is } /** - * @notice Reset the deposit tree since will be replace by a recursive one + * @notice Reset the deposit tree since will be replaced by a recursive one */ function initialize() external virtual initializer { // Get the current historic root diff --git a/contracts/v2/consensus/validium/PolygonValidiumEtrog.sol b/contracts/v2/consensus/validium/PolygonValidiumEtrog.sol index 77b0784e8..c3d8fdd25 100644 --- a/contracts/v2/consensus/validium/PolygonValidiumEtrog.sol +++ b/contracts/v2/consensus/validium/PolygonValidiumEtrog.sol @@ -79,7 +79,7 @@ contract PolygonValidiumEtrog is PolygonRollupBaseEtrog, IPolygonValidium { * @param batches Struct array which holds the necessary data to append new batches to the sequence * @param l1InfoTreeLeafCount Count of the L1InfoTree leaf that will be used in this sequence * @param maxSequenceTimestamp Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). - * This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. + * This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. * @param expectedFinalAccInputHash This parameter must match the acc input hash after hash all the batch data * This will be a protection for the sequencer to avoid sending undesired data * @param l2Coinbase Address that will receive the fees from L2 @@ -249,7 +249,7 @@ contract PolygonValidiumEtrog is PolygonRollupBaseEtrog, IPolygonValidium { * @param batches Struct array which holds the necessary data to append new batches to the sequence * @param l1InfoTreeLeafCount Count of the L1InfoTree leaf that will be used in this sequence * @param maxSequenceTimestamp Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). - * This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. + * This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. * @param expectedFinalAccInputHash This parameter must match the acc input hash after hash all the batch data * This will be a protection for the sequencer to avoid sending undesired data * @param l2Coinbase Address that will receive the fees from L2 diff --git a/contracts/v2/lib/PolygonRollupBaseEtrog.sol b/contracts/v2/lib/PolygonRollupBaseEtrog.sol index 5700c94d1..93bd35bfd 100644 --- a/contracts/v2/lib/PolygonRollupBaseEtrog.sol +++ b/contracts/v2/lib/PolygonRollupBaseEtrog.sol @@ -315,7 +315,7 @@ abstract contract PolygonRollupBaseEtrog is * @param batches Struct array which holds the necessary data to append new batches to the sequence * @param l1InfoTreeLeafCount Count of the L1InfoTree leaf that will be used in this sequence * @param maxSequenceTimestamp Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). - * This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. + * This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. * @param expectedFinalAccInputHash This parameter must match the acc input hash after hash all the batch data * This will be a protection for the sequencer to avoid sending undesired data * @param l2Coinbase Address that will receive the fees from L2 diff --git a/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol b/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol index 8728c2204..44167e947 100644 --- a/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol +++ b/contracts/v2/previousVersions/PolygonRollupBaseEtrogPrevious.sol @@ -398,7 +398,7 @@ abstract contract PolygonRollupBaseEtrogPrevious is * @notice Allows a sequencer to send multiple batches * @param batches Struct array which holds the necessary data to append new batches to the sequence * @param maxSequenceTimestamp Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). - * This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. + * This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. * @param initSequencedBatch This parameter must match the current last batch sequenced. * This will be a protection for the sequencer to avoid sending undesired data * @param l2Coinbase Address that will receive the fees from L2 diff --git a/contracts/v2/previousVersions/PolygonValidiumEtrogPrevious.sol b/contracts/v2/previousVersions/PolygonValidiumEtrogPrevious.sol index 73ae05fd2..4b34eb6b6 100644 --- a/contracts/v2/previousVersions/PolygonValidiumEtrogPrevious.sol +++ b/contracts/v2/previousVersions/PolygonValidiumEtrogPrevious.sol @@ -81,7 +81,7 @@ contract PolygonValidiumEtrogPrevious is * @notice Allows a sequencer to send multiple batches * @param batches Struct array which holds the necessary data to append new batches to the sequence * @param maxSequenceTimestamp Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). - * This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. + * This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. * @param initSequencedBatch This parameter must match the current last batch sequenced. * This will be a protection for the sequencer to avoid sending undesired data * @param l2Coinbase Address that will receive the fees from L2 @@ -256,7 +256,7 @@ contract PolygonValidiumEtrogPrevious is * @notice Allows a sequencer to send multiple batches * @param batches Struct array which holds the necessary data to append new batches to the sequence * @param maxSequenceTimestamp Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). - * This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. + * This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. * @param initSequencedBatch This parameter must match the current last batch sequenced. * This will be a protection for the sequencer to avoid sending undesired data * @param l2Coinbase Address that will receive the fees from L2 diff --git a/contracts/v2/sovereignChains/BridgeL2SovereignChain.sol b/contracts/v2/sovereignChains/BridgeL2SovereignChain.sol index 11ee1c5a3..dda54616e 100644 --- a/contracts/v2/sovereignChains/BridgeL2SovereignChain.sol +++ b/contracts/v2/sovereignChains/BridgeL2SovereignChain.sol @@ -175,7 +175,7 @@ contract BridgeL2SovereignChain is * @notice Remap multiple wrapped tokens to a new sovereign token address * @dev This function is a "multi/batch call" to `setSovereignTokenAddress` * @param originNetworks Array of Origin networks - * @param originTokenAddresses Array od Origin token addresses, 0 address is reserved for ether + * @param originTokenAddresses Array of Origin token addresses, 0 address is reserved for ether * @param sovereignTokenAddresses Array of Addresses of the sovereign wrapped token * @param isNotMintable Array of Flags to indicate if the wrapped token is not mintable */ diff --git a/docs/v2/PolygonZkEVMGlobalExitRootV2.md b/docs/v2/PolygonZkEVMGlobalExitRootV2.md index 481824309..56cb5e7f3 100644 --- a/docs/v2/PolygonZkEVMGlobalExitRootV2.md +++ b/docs/v2/PolygonZkEVMGlobalExitRootV2.md @@ -22,7 +22,7 @@ Contract responsible for managing the exit roots across multiple networks function initialize( ) external ``` -Reset the deposit tree since will be replace by a recursive one +Reset the deposit tree since will be replaced by a recursive one diff --git a/docs/v2/consensus/validium/PolygonValidiumEtrog.md b/docs/v2/consensus/validium/PolygonValidiumEtrog.md index 863d7269c..db4e229bb 100644 --- a/docs/v2/consensus/validium/PolygonValidiumEtrog.md +++ b/docs/v2/consensus/validium/PolygonValidiumEtrog.md @@ -47,7 +47,7 @@ Allows a sequencer to send multiple batches |`batches` | struct PolygonValidiumEtrog.ValidiumBatchData[] | Struct array which holds the necessary data to append new batches to the sequence |`l1InfoTreeLeafCount` | uint32 | Count of the L1InfoTree leaf that will be used in this sequence |`maxSequenceTimestamp` | uint64 | Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). -This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. +This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. |`expectedFinalAccInputHash` | bytes32 | This parameter must match the acc input hash after hash all the batch data This will be a protection for the sequencer to avoid sending undesired data |`l2Coinbase` | address | Address that will receive the fees from L2 @@ -75,7 +75,7 @@ Allows a sequencer to send multiple batches |`batches` | struct PolygonRollupBaseEtrog.BatchData[] | Struct array which holds the necessary data to append new batches to the sequence |`l1InfoTreeLeafCount` | uint32 | Count of the L1InfoTree leaf that will be used in this sequence |`maxSequenceTimestamp` | uint64 | Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). -This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. +This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. |`expectedFinalAccInputHash` | bytes32 | This parameter must match the acc input hash after hash all the batch data This will be a protection for the sequencer to avoid sending undesired data |`l2Coinbase` | address | Address that will receive the fees from L2 diff --git a/docs/v2/lib/PolygonRollupBaseEtrog.md b/docs/v2/lib/PolygonRollupBaseEtrog.md index d244e936c..90426d6b7 100644 --- a/docs/v2/lib/PolygonRollupBaseEtrog.md +++ b/docs/v2/lib/PolygonRollupBaseEtrog.md @@ -69,7 +69,7 @@ Allows a sequencer to send multiple batches |`batches` | struct PolygonRollupBaseEtrog.BatchData[] | Struct array which holds the necessary data to append new batches to the sequence |`l1InfoTreeLeafCount` | uint32 | Count of the L1InfoTree leaf that will be used in this sequence |`maxSequenceTimestamp` | uint64 | Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). -This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. +This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. |`expectedFinalAccInputHash` | bytes32 | This parameter must match the acc input hash after hash all the batch data This will be a protection for the sequencer to avoid sending undesired data |`l2Coinbase` | address | Address that will receive the fees from L2 diff --git a/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md b/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md index 7863170d9..7c994501d 100644 --- a/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md +++ b/docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md @@ -67,7 +67,7 @@ Allows a sequencer to send multiple batches | :--- | :--- | :------------------------------------------------------------------- | |`batches` | struct PolygonRollupBaseEtrogPrevious.BatchData[] | Struct array which holds the necessary data to append new batches to the sequence |`maxSequenceTimestamp` | uint64 | Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). -This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. +This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. |`initSequencedBatch` | uint64 | This parameter must match the current last batch sequenced. This will be a protection for the sequencer to avoid sending undesired data |`l2Coinbase` | address | Address that will receive the fees from L2 diff --git a/docs/v2/previousVersions/PolygonValidiumEtrogPrevious.md b/docs/v2/previousVersions/PolygonValidiumEtrogPrevious.md index 43a0bfb83..c2c085ef7 100644 --- a/docs/v2/previousVersions/PolygonValidiumEtrogPrevious.md +++ b/docs/v2/previousVersions/PolygonValidiumEtrogPrevious.md @@ -45,7 +45,7 @@ Allows a sequencer to send multiple batches | :--- | :--- | :------------------------------------------------------------------- | |`batches` | struct PolygonValidiumEtrogPrevious.ValidiumBatchData[] | Struct array which holds the necessary data to append new batches to the sequence |`maxSequenceTimestamp` | uint64 | Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). -This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. +This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. |`initSequencedBatch` | uint64 | This parameter must match the current last batch sequenced. This will be a protection for the sequencer to avoid sending undesired data |`l2Coinbase` | address | Address that will receive the fees from L2 @@ -71,7 +71,7 @@ Allows a sequencer to send multiple batches | :--- | :--- | :------------------------------------------------------------------- | |`batches` | struct PolygonRollupBaseEtrogPrevious.BatchData[] | Struct array which holds the necessary data to append new batches to the sequence |`maxSequenceTimestamp` | uint64 | Max timestamp of the sequence. This timestamp must be inside a safety range (actual + 36 seconds). -This timestamp should be equal or higher of the last block inside the sequence, otherwise this batch will be invalidated by circuit. +This timestamp should be equal or higher than the last block inside the sequence, otherwise this batch will be invalidated by circuit. |`initSequencedBatch` | uint64 | This parameter must match the current last batch sequenced. This will be a protection for the sequencer to avoid sending undesired data |`l2Coinbase` | address | Address that will receive the fees from L2 diff --git a/docs/v2/sovereignChains/BridgeL2SovereignChain.md b/docs/v2/sovereignChains/BridgeL2SovereignChain.md index a9d4bda92..7ec7cebfc 100644 --- a/docs/v2/sovereignChains/BridgeL2SovereignChain.md +++ b/docs/v2/sovereignChains/BridgeL2SovereignChain.md @@ -70,7 +70,7 @@ This function is a "multi/batch call" to `setSovereignTokenAddress` | Name | Type | Description | | :--- | :--- | :------------------------------------------------------------------- | |`originNetworks` | uint32[] | Array of Origin networks -|`originTokenAddresses` | address[] | Array od Origin token addresses, 0 address is reserved for ether +|`originTokenAddresses` | address[] | Array of Origin token addresses, 0 address is reserved for ether |`sovereignTokenAddresses` | address[] | Array of Addresses of the sovereign wrapped token |`isNotMintable` | bool[] | Array of Flags to indicate if the wrapped token is not mintable diff --git a/tools/createSovereignGenesis/README.md b/tools/createSovereignGenesis/README.md index d2d9ed695..1b1d92011 100644 --- a/tools/createSovereignGenesis/README.md +++ b/tools/createSovereignGenesis/README.md @@ -1,9 +1,9 @@ # Create sovereign genesis -Script to generate the genesis file for a rollup with `SovereignContracts`. This genesis si aim to be used for chains that are run with vanilla clients. +Script to generate the genesis file for a rollup with `SovereignContracts`. This genesis aims to be used for chains that are run with vanilla clients. This script should be run after the rollup is created, so its `rollupID` and the bridge initialization parameters are known. The script does the following: - read base genesis file -- deploy sovereign cobtracts +- deploy sovereign contracts - initialize them ## Setup diff --git a/tools/deployVerifier/README.md b/tools/deployVerifier/README.md index 142da8e86..6f9ea008f 100644 --- a/tools/deployVerifier/README.md +++ b/tools/deployVerifier/README.md @@ -8,8 +8,8 @@ npm i ## Setup - Config file `deploy_verifier_parameters.json`: - - `realVerifier`: select between a real or a mock verifer - - `forkID`: Select fork to verifier to be deployed (if a real verfifier is selected) + - `realVerifier`: select between a real or a mock verifier + - `forkID`: Select fork to verifier to be deployed (if a real verifier is selected) - `deployerPvtKey`: private key deployer - First option will load `deployerPvtKey`. Otherwise, `process.env.MNEMONIC` will be loaded from the `.env` file - `maxFeePerGas`: set custom gas