Commit 98e1f4d9 authored by shuoer86's avatar shuoer86

docs: fix typos

parent a9f62bb3
...@@ -59,7 +59,7 @@ Optimism's smart contracts are written in Solidity and we use [foundry](https:// ...@@ -59,7 +59,7 @@ Optimism's smart contracts are written in Solidity and we use [foundry](https://
1. [golang](https://golang.org/doc/install) 1. [golang](https://golang.org/doc/install)
1. [python](https://www.python.org/downloads/) 1. [python](https://www.python.org/downloads/)
Our [Style Guide](STYLE_GUIDE.md) contains information about the project structure, syntax preferences, naming conventions, and more. Please take a look at it before submitting a PR, and let us know if you spot inconcistencies! Our [Style Guide](STYLE_GUIDE.md) contains information about the project structure, syntax preferences, naming conventions, and more. Please take a look at it before submitting a PR, and let us know if you spot inconsistencies!
Once you've read the styleguide and are ready to work on your PR, there are a plethora of useful `pnpm` scripts to know about that will help you with development: Once you've read the styleguide and are ready to work on your PR, there are a plethora of useful `pnpm` scripts to know about that will help you with development:
1. `pnpm build` Builds the smart contracts. 1. `pnpm build` Builds the smart contracts.
......
...@@ -197,7 +197,7 @@ As mentioned earlier in [memory](#memory), all memory operations are 4-byte alig ...@@ -197,7 +197,7 @@ As mentioned earlier in [memory](#memory), all memory operations are 4-byte alig
Since pre-image I/O occurs on memory, all pre-image I/O operations must strictly adhere to alignment boundaries. Since pre-image I/O occurs on memory, all pre-image I/O operations must strictly adhere to alignment boundaries.
This means the start and end of a read/write operation must fall within the same alignment boundary. This means the start and end of a read/write operation must fall within the same alignment boundary.
If an operation were to violate this, the input `count` of the read/write syscall must be If an operation were to violate this, the input `count` of the read/write syscall must be
truncated such that the effective address of the last byte read/writtten matches the input effective address. truncated such that the effective address of the last byte read/written matches the input effective address.
The VM must read/write the maximum amount of bytes possible without crossing the input address alignment boundary. The VM must read/write the maximum amount of bytes possible without crossing the input address alignment boundary.
For example, the effect of a write request for a 3-byte aligned buffer must be exactly 3 bytes. For example, the effect of a write request for a 3-byte aligned buffer must be exactly 3 bytes.
...@@ -215,4 +215,4 @@ outside the general purpose registers). ...@@ -215,4 +215,4 @@ outside the general purpose registers).
VM implementations may raise an exception in other cases that is specific to the implementation. VM implementations may raise an exception in other cases that is specific to the implementation.
For example, an on-chain FPVM that relies on pre-supplied merkle proofs for memory access may For example, an on-chain FPVM that relies on pre-supplied merkle proofs for memory access may
raise an exception if the supplied merkle proof doees not match the pre-state `memRoot`. raise an exception if the supplied merkle proof does not match the pre-state `memRoot`.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment