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 #106

Open
wants to merge 3 commits into
base: main
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 config/mainnet/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export namespace s {
IL1Block__factory.abi,
optimismProvider,
)
export const optimimsmmainnetL2L1MessageParserContract = new Contract(
export const optimismmainnetL2L1MessageParserContract = new Contract(
networks.optimism.proving.l2l1MessageParserAddress,
L2ToL1MessagePasserArtifact.abi,
optimismProvider,
Expand Down
2 changes: 1 addition & 1 deletion config/testnet/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export namespace s {
IL1Block__factory.abi,
optimismSepoliaProvider,
)
export const optimimsmSepoliaL2L1MessageParserContract = new Contract(
export const optimismSepoliaL2L1MessageParserContract = new Contract(
networks.optimismSepolia.proving.l2l1MessageParserAddress,
L2ToL1MessagePasserArtifact.abi,
optimismSepoliaProvider,
Expand Down
8 changes: 4 additions & 4 deletions contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,10 @@ It is recommended to use `nvm` to install Node. This is a Node version manager s

1. Install `nvm` using the following command in your terminal:

<ins>Security:</ins> This method has no permissioning, it can be called by anyone. Notably, it asks the user for raw calldata to be executed by the filler, and transfers tokens from the user into the IntentSource contract. It is very important, therefore, that a user know exactly what commands they are executing and what their consequences are, as well as what tokens in what quantity they intend to lock up. Also, the user must give this contract permission to move their tokens via a method like permit or approve, otherwise it will revert.
<ins>Security:</ins> This method has no permissioning, it can be called by anyone. Notably, it asks the user for raw calldata to be executed by the filler, and transfers tokens from the user into the IntentSource contract. It is very important, therefore, that a user knows exactly what commands they are executing and what their consequences are, as well as what tokens in what quantity they intend to lock up. Also, the user must give this contract permission to move their tokens via a method like permit or approve, otherwise it will revert.

<h4><ins>withdrawRewards</ins></h4>
<h5>Allows withdawal of reward funds locked up for a given intent.</h5>
<h5>Allows withdrawal of reward funds locked up for a given intent.</h5>

Attributes:

Expand Down Expand Up @@ -284,7 +284,7 @@ Attributes:

Attributes:

- ` ` (uint32) this variable is not used, but is required by the interface. it is the chain ID of the intent's origin chain.
- ` ` (uint32) this variable is not used, but is required by the interface. It is the chain ID of the intent's origin chain.
- `_sender` (bytes32) the address that called dispatch() on the HyperLane Mailbox on the destination chain
- `_messageBody` (bytes) the message body containing intent hashes and their corresponding claimants

Expand Down Expand Up @@ -333,7 +333,7 @@ Attributes:
<h4><ins>proveWorldStateBedrock</ins></h4>
<h5> Validates World state by ensuring that the passed in world state root corresponds to value in the L2 output oracle on the Settlement Layer. We submit a `StorageProof` proving that the L2 Block is included in a batch that has been settled to L1 and an `AccountProof` proving that the `StorageProof` submitted is linked to a `WorldState` for the contract that the `StorageProof` is for.</h5>

For Optimisms BedRock release we submit an `outputRoot` storage proof created by concatenating
For Optimism's BedRock release we submit an `outputRoot` storage proof created by concatenating

```solidity
output_root = kecakk256( version_byte || state_root || withdrawal_storage_root || latest_block_hash)
Expand Down