Skip to content

Commit c70ee4a

Browse files
krausptncitron
andauthored
docs: spec links (#211)
* fix: broken op links in docs * fix: broken links to op specs in code --------- Co-authored-by: Noah Citron <[email protected]>
1 parent 819fe52 commit c70ee4a

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/architecture.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The Pipeline is broken up into [stages](../src/derive/stages/mod.rs) as follows.
3434

3535
##### Batcher Transactions
3636

37-
The [Batcher Transactions](../src/derive/stages/batcher_transactions.rs) stage pulls transactions from its configured channel receiver, passed down from the [Pipeline](../src/derive/mod.rs) parent. To construct a [Batcher Transaction](../src/derive/stages/batcher_transactions.rs) from the raw transaction data, it constructs [Frames](../src/derive/stages/batcher_transactions.rs) following the [Batch Submission Wire Format](https://github.com/ethereum-optimism/optimism/blob/develop/specs/derivation.md#batch-submission-wire-format) documented in the [Optimism Specs](https://github.com/ethereum-optimism/optimism/blob/develop/specs/README.md).
37+
The [Batcher Transactions](../src/derive/stages/batcher_transactions.rs) stage pulls transactions from its configured channel receiver, passed down from the [Pipeline](../src/derive/mod.rs) parent. To construct a [Batcher Transaction](../src/derive/stages/batcher_transactions.rs) from the raw transaction data, it constructs [Frames](../src/derive/stages/batcher_transactions.rs) following the [Batch Submission Wire Format](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/derivation.md#batch-submission-wire-format) documented in the [Optimism Specs](https://github.com/ethereum-optimism/specs/tree/main).
3838

3939
##### Channels
4040

@@ -44,7 +44,7 @@ Remember, since the [L1 Chain Watcher](#l1-chain-watcher) is spawned as a separa
4444

4545
##### Batches
4646

47-
Next up, the [Batches](../src/derive/stages/batches.rs) stage iterates over the prior [Channel](../src/derive/stages/channels.rs) stage, decoding [Batch](../src/derive/stages/batches.rs) objects from the inner channel data. [Batch](../src/derive/stages/batches.rs) objects are RLP-decoded from the channel data following the [Batch Encoding Format](https://github.com/ethereum-optimism/optimism/blob/develop/specs/derivation.md#batch-format), detailed below.
47+
Next up, the [Batches](../src/derive/stages/batches.rs) stage iterates over the prior [Channel](../src/derive/stages/channels.rs) stage, decoding [Batch](../src/derive/stages/batches.rs) objects from the inner channel data. [Batch](../src/derive/stages/batches.rs) objects are RLP-decoded from the channel data following the [Batch Encoding Format](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/derivation.md#batch-format), detailed below.
4848

4949
For version 0, [Batch](../src/derive/stages/batches.rs) objects are encoded as follows:
5050

src/engine/payload.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ impl TryFrom<Block<Transaction>> for ExecutionPayload {
8383
/// ## PayloadAttributes
8484
///
8585
/// L2 extended payload attributes for Optimism.
86-
/// For more details, visit the [Optimism specs](https://specs.optimism.io/protocol/exec-engine.html#engine-api).
86+
/// For more details, visit the [Optimism specs](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/exec-engine.md#extended-payloadattributesv1).
8787
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
8888
#[serde(rename_all = "camelCase")]
8989
pub struct PayloadAttributes {

src/engine/traits.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use super::{
1010
///
1111
/// A set of methods that allow a consensus client to interact with an execution engine.
1212
/// This is a modified version of the [Ethereum Execution API Specs](https://github.com/ethereum/execution-apis),
13-
/// as defined in the [Optimism Exec Engine Specs](https://specs.optimism.io/protocol/exec-engine.html).
13+
/// as defined in the [Optimism Exec Engine Specs](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/exec-engine.md).
1414
#[async_trait]
1515
pub trait Engine: Send + Sync + 'static {
1616
/// ## forkchoice_updated
@@ -37,7 +37,7 @@ pub trait Engine: Send + Sync + 'static {
3737
///
3838
/// ### Reference
3939
///
40-
/// See more details in the [Optimism Specs](https://specs.optimism.io/protocol/exec-engine.html#engine_forkchoiceupdatedv2).
40+
/// See more details in the [Optimism Specs](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/exec-engine.md#engine_forkchoiceupdatedv1).
4141
async fn forkchoice_updated(
4242
&self,
4343
forkchoice_state: ForkchoiceState,
@@ -66,7 +66,7 @@ pub trait Engine: Send + Sync + 'static {
6666
///
6767
/// ### Reference
6868
///
69-
/// See more details in the [Optimism Specs](https://specs.optimism.io/protocol/exec-engine.html#engine_newPayloadv2).
69+
/// See more details in the [Optimism Specs](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/exec-engine.md#engine_newPayloadv1).
7070
async fn new_payload(&self, execution_payload: ExecutionPayload) -> Result<PayloadStatus>;
7171

7272
/// ## get_payload
@@ -92,6 +92,6 @@ pub trait Engine: Send + Sync + 'static {
9292
///
9393
/// ### Reference
9494
///
95-
/// See more details in the [Optimism Specs](https://specs.optimism.io/protocol/exec-engine.html#engine_getPayloadv2).
95+
/// See more details in the [Optimism Specs](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/exec-engine.md#engine_getPayloadv1).
9696
async fn get_payload(&self, payload_id: PayloadId) -> Result<ExecutionPayload>;
9797
}

0 commit comments

Comments
 (0)