Skip to content
Merged
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 .github/ISSUE_TEMPLATE/general_docs_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ labels: 'community-request,documentation'

---

<!-- please fill out the description and acceptance criteria to the best to your ability. While the other sections are optional, it makes resolving the issue much easier. -->
<!-- please fill out the description and acceptance criteria to the best of your ability. While the other sections are optional, it makes resolving the issue much easier. -->

## Description
<!-- Write a clear and concise description of the docs request. For example, is the request related to an existing page or are you suggesting a brand-new docs page? -->
Expand Down
2 changes: 1 addition & 1 deletion connect/contribute/stack-contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To start contributing components to the stack, check out some of these [useful i

The OP Stack codebase is not a product (in the traditional sense) but rather a collection of software components that power the Optimism ecosystem.
If you'd like to contribute to the current release of OP Stack codebase, rather than creating new components, your contribution would be greatly appreciated.
**A "Release"of the OP Stack codebase is a particular set of software components that are production-ready and which fit the stack's design principles and goals.**
**A "Release" of the OP Stack codebase is a particular set of software components that are production-ready and which fit the stack's design principles and goals.**

To make your first contribution to the codebase, check out the [open issues](https://github.com/ethereum-optimism/optimism/issues) on the Optimism Monorepo.

Expand Down
6 changes: 3 additions & 3 deletions connect/resources/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

### Address aliasing

When a contract submits a [deposit](#deposit) from L1 to L2, it's address (as returned by `ORIGIN` and `CALLER`) will be
When a contract submits a [deposit](#deposit) from L1 to L2, its address (as returned by `ORIGIN` and `CALLER`) will be
aliased with a modified representation of the address of a contract.

### Block
Expand Down Expand Up @@ -85,10 +85,10 @@
### PGA or priority gas auction

Transactions in ethereum are ordered by the price that the transaction pays to the miner. Priority Gas Auctions
(PGAs) occur when multiple parties are competing to be the first transaction in a block. Each party continuously

Check warning on line 88 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L88

Did you really mean 'PGAs'?
updates the gas price of their transaction. PGAs occur when there is value in submitting a transaction before other

Check warning on line 89 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L89

Did you really mean 'PGAs'?
parties (like being the first deposit or submitting a deposit before there is not more guaranteed gas remaining).
PGAs tend to have negative externalities on the network due to a large amount of transactions being submitted in a

Check warning on line 91 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L91

Did you really mean 'PGAs'?
very short amount of time.

### Receipt
Expand Down Expand Up @@ -131,7 +131,7 @@
### Validator mode

The rollup node performs derivation as indicated in sequencer mode, but is also able to "run ahead" of the L1
chain by getting blocks directly from the sequencer, in which case derivation serves to validate the sequencer's

Check warning on line 134 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L134

Did you really mean 'sequencer's'?
behavior. A rollup node running in validator mode is sometimes called *a replica*.

\[[return to top](#table-of-contents)]
Expand Down Expand Up @@ -189,7 +189,7 @@

### Attestation proof

A proof which consists of some number of signatures from a pre-agreed upon set of chain attestors.

Check warning on line 192 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L192

Did you really mean 'attestors'?

### Cannon fault proof

Expand All @@ -215,7 +215,7 @@

the L1 origin of an L2 block is the L1 block corresponding to its [sequencing epoch](#sequencing-epoch).

### Merkle patricia trie

Check warning on line 218 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L218

Did you really mean 'patricia'?

sparse [trie](https://en.wikipedia.org/wiki/Trie), which is a tree-like structure that maps keys to values.
The root hash of a MPT is a commitment to the contents of the tree, which allows a proof to be constructed for any key-value mapping encoded in the tree. Such a proof is called a Merkle proof, and can be
Expand All @@ -235,7 +235,7 @@

### OP Mainnet

Layer 2 blockchain powered by the OP Stack. Previously known as just "Optimism,"OP Mainnet is where it all started, and the first chain to commit to the Superchain vision.
Layer 2 blockchain powered by the OP Stack. Previously known as just "Optimism," OP Mainnet is where it all started, and the first chain to commit to the Superchain vision.

### OP Stack

Expand Down Expand Up @@ -314,7 +314,7 @@

Transaction submitted by a [batcher](#batcher) to a data availability provider, in order to make
channels available. These transactions carry one or more full frames, which may belong to different channels. A
channel's frame may be split between multiple batcher transactions. When submitted to Ethereum calldata, the batcher

Check warning on line 317 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L317

Did you really mean 'calldata'?
transaction's receiver must be the sequencer inbox address. The transaction must also be signed by a recognized batch submitter account.

### Channel
Expand Down Expand Up @@ -355,7 +355,7 @@

Guarantee that some data will be "available" (i.e. *retrievable*) during a reasonably long time
window. In Optimism's case, the data in question are [sequencer batches](#sequencer-batch) that [validators](#validator)
need in order to verify the sequencer's work and validate the L2 chain. The [finalization period](#finalization-period)

Check warning on line 358 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L358

Did you really mean 'sequencer's'?
should be taken as the lower bound on the availability window, since that is when data availability is the most crucial,
as it is needed to perform a [fault proof](#fault-proof). "Availability" **does not** mean guaranteed long-term storage of the data.

Expand All @@ -375,8 +375,8 @@
emitted as log records (in Solidity, these are called *events*) for consumption by [rollup nodes](#rollup-node).

<Info>
The deposits are not stored in calldata because they can be sent by contracts, in which case the calldata

Check warning on line 378 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L378

Did you really mean 'calldata'?

Check warning on line 378 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L378

Did you really mean 'calldata'?
is part of the *internal* execution between contracts, and this intermediate calldata is not captured in one of the

Check warning on line 379 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L379

Did you really mean 'calldata'?
[Merkle Patricia Trie roots](#merkle-patricia-trie) included in the L1 block.
</Info>

Expand All @@ -394,7 +394,7 @@
### Depositing Call

L1 call to the deposit contract, which will be derived to a [user-deposited transaction](#user-deposited-transaction) by the rollup driver.
This call specifies all the data (destination, value, calldata, ...) for the deposited transaction.

Check warning on line 397 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L397

Did you really mean 'calldata'?

### Depositing Transaction

Expand All @@ -416,7 +416,7 @@
### Finalization Period

The minimum amount of time (in seconds) that must elapse before a withdrawal can be finalized, sometimes called **withdrawal delay**.
The finalization period is necessary to afford sufficient time for validators to make a fault proof.

Check warning on line 419 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L419

Did you really mean 'validators'?

### L1 Attributes Deposited Transaction

Expand Down Expand Up @@ -451,7 +451,7 @@
then passed to the [execution engine](#execution-engine) to construct L2 blocks. The payload attributes object essentially
encodes a [block](#block) without output properties.

### Relayer

Check warning on line 454 in connect/resources/glossary.mdx

View check run for this annotation

Mintlify / Mintlify Validation (optimism-373f39ad) - vale-spellcheck

connect/resources/glossary.mdx#L454

Did you really mean 'Relayer'?

EOA on L1 which finalizes a withdrawal by submitting the data necessary to verify its inclusion on L2.

Expand Down Expand Up @@ -503,7 +503,7 @@
### User-Deposited Transaction

Deposited transaction which is derived from an L1 call to the deposit contract and [depositing call](#depositing-call); explicitly excludes [L1 attributes deposited
transactions](#l1-attributes-depositedtransaction).
transactions](#l1-attributes-deposited-transaction).

### Withdrawal transaction

Expand Down