Skip to content
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

Fix typos #194

Open
wants to merge 6 commits 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 docs/lib/DepositContractLib.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Verify merkle proof
uint32 index
) public returns (bytes32)
```
calcualte root from merkle proof
calculate root from merkle proof


#### Parameters:
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/PolygonRollupManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ them will be done in this one. In this way, the proof aggregation of the rollups
|`admin` | address | Admin of the rollup manager
|`timelock` | address | Timelock address
|`emergencyCouncil` | address | Emergency council address
|`polygonZkEVM` | contract PolygonZkEVMExistentEtrog | New deployed Polygon zkEVM which will be initialized wiht previous values
|`polygonZkEVM` | contract PolygonZkEVMExistentEtrog | New deployed Polygon zkEVM which will be initialized with previous values
|`zkEVMVerifier` | contract IVerifierRollup | Verifier of the new zkEVM deployed
|`zkEVMForkID` | uint64 | Fork id of the new zkEVM deployed
|`zkEVMChainID` | uint64 | Chain id of the new zkEVM deployed
Expand Down Expand Up @@ -772,7 +772,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/PolygonZkEVMBridgeV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Contract responsible to manage the token interactions with other networks
function constructor(
) public
```
Disable initalizers on the implementation following the best practices
Disable initializers on the implementation following the best practices



Expand Down
4 changes: 2 additions & 2 deletions docs/v2/consensus/dataComittee/CDKDataCommittee.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
```
Allows the admin to setup the members of the committee. Note that:
The system will require N / M signatures where N => _requiredAmountOfSignatures and M => urls.length
There must be the same amount of urls than addressess encoded in the addrsBytes
There must be the same amount of urls than addresses encoded in the addrsBytes
A member is represented by the url and the address contained in urls[i] and addrsBytes[i*_ADDR_SIZE : i*_ADDR_SIZE + _ADDR_SIZE]


Expand All @@ -30,7 +30,7 @@ A member is represented by the url and the address contained in urls[i] and addr
| :--- | :--- | :------------------------------------------------------------------- |
|`_requiredAmountOfSignatures` | uint256 | Required amount of signatures
|`urls` | string[] | List of urls of the members of the committee
|`addrsBytes` | bytes | Byte array that contains the addressess of the members of the committee
|`addrsBytes` | bytes | Byte array that contains the addresses of the members of the committee

### getAmountOfMembers
```solidity
Expand Down
6 changes: 3 additions & 3 deletions docs/v2/consensus/validium/PolygonDataCommittee.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
function constructor(
) public
```
Disable initalizers on the implementation following the best practices
Disable initializers on the implementation following the best practices



Expand All @@ -30,7 +30,7 @@ Disable initalizers on the implementation following the best practices
```
Allows the admin to setup the members of the committee. Note that:
The system will require N / M signatures where N => _requiredAmountOfSignatures and M => urls.length
There must be the same amount of urls than addressess encoded in the addrsBytes
There must be the same amount of urls than addresses encoded in the addrsBytes
A member is represented by the url and the address contained in urls[i] and addrsBytes[i*_ADDR_SIZE : i*_ADDR_SIZE + _ADDR_SIZE]


Expand All @@ -39,7 +39,7 @@ A member is represented by the url and the address contained in urls[i] and addr
| :--- | :--- | :------------------------------------------------------------------- |
|`_requiredAmountOfSignatures` | uint256 | Required amount of signatures
|`urls` | string[] | List of urls of the members of the committee
|`addrsBytes` | bytes | Byte array that contains the addressess of the members of the committee
|`addrsBytes` | bytes | Byte array that contains the addresses of the members of the committee

### verifyMessage
```solidity
Expand Down
4 changes: 2 additions & 2 deletions tools/addRollupType/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ cd deployment
cp upgrade_parameters.json.example upgrade_parameters.json
```

Fill created `upgrade_parameters.json` with appropiate parameters.
You should fullfill the upgrades array, with all the updates that you intend to do ( more information in `upgrade-parameters.json` section)
Fill created `upgrade_parameters.json` with appropriate parameters.
You should fulfill the upgrades array, with all the updates that you intend to do ( more information in `upgrade-parameters.json` section)

if the deployment was deployed without a timelock you can use the `simpleUpgradeScript.js`:

Expand Down