Skip to content

fix: typos #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contracts/v2/PolygonZkEVMGlobalExitRootV2.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions contracts/v2/consensus/validium/PolygonValidiumEtrog.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion contracts/v2/lib/PolygonRollupBaseEtrog.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion contracts/v2/sovereignChains/BridgeL2SovereignChain.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/PolygonZkEVMGlobalExitRootV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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



Expand Down
4 changes: 2 additions & 2 deletions docs/v2/consensus/validium/PolygonValidiumEtrog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/lib/PolygonRollupBaseEtrog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/previousVersions/PolygonValidiumEtrogPrevious.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/sovereignChains/BridgeL2SovereignChain.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions tools/createSovereignGenesis/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions tools/deployVerifier/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down