Skip to content

chore: fix typos #427

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
8 changes: 4 additions & 4 deletions contracts/PolygonZkEVM.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
*/
Expand All @@ -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 {
Expand Down Expand Up @@ -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 {
Expand Down
10 changes: 5 additions & 5 deletions contracts/v2/PolygonRollupManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion contracts/v2/lib/PolygonConsensusBase.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions contracts/v2/lib/PolygonRollupBaseEtrog.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
*/
Expand Down
8 changes: 4 additions & 4 deletions docs/PolygonZkEVM.md
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/v2/PolygonRollupManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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



Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/lib/PolygonConsensusBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/lib/PolygonRollupBaseEtrog.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,15 +250,15 @@ 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
event RollbackBatches(
)
```

Emitted when a aggregator verifies batches
Emitted when an aggregator verifies batches

### SetForceBatchTimeout
```solidity
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/previousVersions/PolygonRollupBaseEtrogPrevious.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/previousVersions/PolygonRollupManagerPrevious.md
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand All @@ -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:
Expand Down