Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Chore: Typo correction #22

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Chore: Typo correction #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6a2a3f
Chore: Typo correction operational.md
osrm Aug 1, 2024
a52738b
Chore: Typo correction linea-token-bridge.md
osrm Aug 1, 2024
ebf8392
Merge branch 'Consensys:main' into main
osrm Dec 9, 2024
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/linea-token-bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Documentation

Token Bridge is a canonical brige between Ethereum and Linea networks.
Token Bridge is a canonical bridge between Ethereum and Linea networks.

## Install

Expand Down
38 changes: 19 additions & 19 deletions docs/operational.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Parameters that should be filled either in .env or passed as CLI arguments:
| ------------------ | -------- | ---------- | ----------- |
| \**PRIVATE_KEY* | true | key | Network-specific private key used when deploying the contract |
| INFURA_API_KEY | true | key | Infura API Key |
| CONTRACT_TYPE | true | Contract name | Contract name parameter. If ommited in the .env, it must be provided as CLI argument using the `--contract-type` flag |
| PROXY_ADDRESS | true | address | Proxy contract address. If ommited in the .env, it must be provided as CLI argument using the `--proxy-address` flag|
| CONTRACT_TYPE | true | Contract name | Contract name parameter. If omitted in the .env, it must be provided as CLI argument using the `--contract-type` flag |
| PROXY_ADDRESS | true | address | Proxy contract address. If omitted in the .env, it must be provided as CLI argument using the `--proxy-address` flag|


<br />
Expand Down Expand Up @@ -72,10 +72,10 @@ Parameters that should be filled either in .env or passed as CLI arguments:
| ------------------ | -------- | ---------- | ----------- |
| \**PRIVATE_KEY* | true | key | Network-specific private key used when deploying the contract |
| INFURA_API_KEY | true | key | Infura API Key |
| CONTRACT_TYPE | true | Contract name | Contract name parameter. If ommited in the .env, it must be provided as CLI argument using the `--contract-type` flag |
| PROXY_ADDRESS | true | address | Proxy contract address. If ommited in the .env, it must be provided as CLI argument using the `--proxy-address` flag|
| ADMIN_ADDRESS | true | address | Admin address to which role will be granted. If ommited in the .env, it must be provided as CLI argument using the `--admin-address` flag|
| CONTRACT_ROLES | true | bytes | Comma-separated list of bytes32-formatted roles that will be granted to the Admin address. If ommited in the .env, it must be provided as CLI argument using the `--contract-roles` flag|
| CONTRACT_TYPE | true | Contract name | Contract name parameter. If omitted in the .env, it must be provided as CLI argument using the `--contract-type` flag |
| PROXY_ADDRESS | true | address | Proxy contract address. If omitted in the .env, it must be provided as CLI argument using the `--proxy-address` flag|
| ADMIN_ADDRESS | true | address | Admin address to which role will be granted. If omitted in the .env, it must be provided as CLI argument using the `--admin-address` flag|
| CONTRACT_ROLES | true | bytes | Comma-separated list of bytes32-formatted roles that will be granted to the Admin address. If omitted in the .env, it must be provided as CLI argument using the `--contract-roles` flag|

<br />

Expand Down Expand Up @@ -112,11 +112,11 @@ Parameters that should be filled either in .env or passed as CLI arguments:
| ------------------ | -------- | ---------- | ----------- |
| \**PRIVATE_KEY* | true | key | Network-specific private key used when deploying the contract |
| INFURA_API_KEY | true | key | Infura API Key |
| OLD_ADMIN_ADDRESS | true | address | Old admin address. If ommited in the .env, it must be provided as CLI argument using the `--old-admin-address` flag |
| NEW_ADMIN_ADDRESS | true | address | New admin address. If ommited in the .env, it must be provided as CLI argument using the `--new-admin-address` flag |
| PROXY_ADDRESS | true | address | Proxy contract address. If ommited in the .env, it must be provided as CLI argument using the `--proxy-address` flag|
| CONTRACT_TYPE | true | Contract name | Contract name parameter. If ommited in the .env, it must be provided as CLI argument using the `--contract-type` flag |
| CONTRACT_ROLES | true | bytes | Comma-separated bytes32-formatted roles that will be renounced from the Old Admin address. New admin will be checked for roles before revoking from Old admin. If ommited in the .env, it must be provided as CLI argument using the `--contract-roles` flag|
| OLD_ADMIN_ADDRESS | true | address | Old admin address. If omitted in the .env, it must be provided as CLI argument using the `--old-admin-address` flag |
| NEW_ADMIN_ADDRESS | true | address | New admin address. If omitted in the .env, it must be provided as CLI argument using the `--new-admin-address` flag |
| PROXY_ADDRESS | true | address | Proxy contract address. If omitted in the .env, it must be provided as CLI argument using the `--proxy-address` flag|
| CONTRACT_TYPE | true | Contract name | Contract name parameter. If omitted in the .env, it must be provided as CLI argument using the `--contract-type` flag |
| CONTRACT_ROLES | true | bytes | Comma-separated bytes32-formatted roles that will be renounced from the Old Admin address. New admin will be checked for roles before revoking from Old admin. If omitted in the .env, it must be provided as CLI argument using the `--contract-roles` flag|
<br />

Base command:
Expand Down Expand Up @@ -158,9 +158,9 @@ Parameters that should be filled either in .env or passed as CLI arguments:
| ------------------ | -------- | ---------- | ----------- |
| \**PRIVATE_KEY* | true | key | Network-specific private key used when deploying the contract |
| INFURA_API_KEY | true | key | Infura API Key |
| MESSAGE_SERVICE_TYPE | true | contract name | Contract name parameter. If ommited in the .env, it must be provided as CLI argument using the `--message-service-type` flag |
| MESSAGE_SERVICE_ADDRESS | true | address | Proxy contract address. If ommited in the .env, it must be provided as CLI argument using the `--message-service-address` flag|
| WITHDRAW_LIMIT_IN_WEI | true | uint256 | Withdraw limit denominated in wei. If ommited in the .env, it must be provided as CLI argument using the `--withdraw-limit` flag|
| MESSAGE_SERVICE_TYPE | true | contract name | Contract name parameter. If omitted in the .env, it must be provided as CLI argument using the `--message-service-type` flag |
| MESSAGE_SERVICE_ADDRESS | true | address | Proxy contract address. If omitted in the .env, it must be provided as CLI argument using the `--message-service-address` flag|
| WITHDRAW_LIMIT_IN_WEI | true | uint256 | Withdraw limit denominated in wei. If omitted in the .env, it must be provided as CLI argument using the `--withdraw-limit` flag|
<br />

Base command:
Expand Down Expand Up @@ -195,10 +195,10 @@ Parameters that should be filled either in .env or passed as CLI arguments:
| ------------------ | -------- | ---------- | ----------- |
| \**PRIVATE_KEY* | true | key | Network-specific private key used when deploying the contract |
| INFURA_API_KEY | true | key | Infura API Key |
| VERIFIER_PROOF_TYPE | true | uint256 | Verifier Proof type ("0" - Full Verifier, "1" - Full-Large Verifier, "2" - Light Verifier). If ommited in the .env, it must be provided as CLI argument using the `--verifier-proof-type` flag| |
| LINEA_ROLLUP_ADDRESS | true | address | Proxy contract address. If ommited in the .env, it must be provided as CLI argument using the `--proxy-address` flag|
| VERIFIER_ADDRESS | true | address | Verifier Address. If ommited in the .env, it must be provided as CLI argument using the `--verifier-address` flag|
| VERIFIER_NAME | true | address | Verifier Name. If ommited in the .env, it must be provided as CLI argument using the `--verifier-name` flag|
| VERIFIER_PROOF_TYPE | true | uint256 | Verifier Proof type ("0" - Full Verifier, "1" - Full-Large Verifier, "2" - Light Verifier). If omitted in the .env, it must be provided as CLI argument using the `--verifier-proof-type` flag| |
| LINEA_ROLLUP_ADDRESS | true | address | Proxy contract address. If omitted in the .env, it must be provided as CLI argument using the `--proxy-address` flag|
| VERIFIER_ADDRESS | true | address | Verifier Address. If omitted in the .env, it must be provided as CLI argument using the `--verifier-address` flag|
| VERIFIER_NAME | true | address | Verifier Name. If omitted in the .env, it must be provided as CLI argument using the `--verifier-name` flag|

<br />

Expand Down Expand Up @@ -271,4 +271,4 @@ npx hardhat transferOwnershipAndSetRemoteTokenBridge \
(make sure to replace `<key>` with actual values)

<br />
<br />
<br />