From 38d522d831fc96628151a9931470f996e2068f50 Mon Sep 17 00:00:00 2001 From: refcell Date: Mon, 4 Nov 2024 19:23:29 -0500 Subject: [PATCH 1/2] book: links --- book/src/building/consensus.md | 19 +------- book/src/building/genesis/README.md | 4 +- book/src/building/genesis/rollup-config.md | 9 ++-- book/src/building/genesis/system-config.md | 36 +++++++-------- book/src/building/rollup-configs.md | 9 ++-- book/src/links.md | 52 +++++++++++++++++++--- 6 files changed, 74 insertions(+), 55 deletions(-) diff --git a/book/src/building/consensus.md b/book/src/building/consensus.md index ad6640d70..909c1e0dc 100644 --- a/book/src/building/consensus.md +++ b/book/src/building/consensus.md @@ -16,7 +16,7 @@ the `alloy-consensus` types should be used instead. ## Block -[`op-alloy-consensus`][consensus] exports an Optimism block type, [`OpBlock`][block]. +[`op-alloy-consensus`][consensus] exports an Optimism block type, [`OpBlock`][op-block]. This type simply re-uses the `alloy-consensus` block type, with `OpTxEnvelope` as the type of transactions in the block. @@ -81,19 +81,4 @@ are the following. - [`Hardforks::fjord_txs()`][fjord] - - -[deposit]: https://specs.optimism.io/protocol/deposits.html -[alloy]: https://github.com/alloy-rs/alloy -[fjord]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/hardforks/struct.Hardforks.html#method.fjord_txs -[ecotone]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/hardforks/struct.Hardforks.html#method.ecotone_txs -[hardforks]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/hardforks/struct.Hardforks.html -[odr]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/struct.OpDepositReceipt.html -[ore]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpReceiptEnvelope.html -[block]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/type.OpBlock.html -[ty]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpTxType.html -[specs]: https://specs.optimism.io/protocol/deposits.html -[tx-envelope]: https://docs.rs/alloy-consensus/latest/alloy_consensus/transaction/enum.TxEnvelope.html -[envelope]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpTxEnvelope.html -[2718]: https://eips.ethereum.org/EIPS/eip-2718 -[consensus]: https://crates.io/crates/op-alloy-consensus +{{#include ../links.md}} diff --git a/book/src/building/genesis/README.md b/book/src/building/genesis/README.md index d9277b210..9263b5e08 100644 --- a/book/src/building/genesis/README.md +++ b/book/src/building/genesis/README.md @@ -2,11 +2,11 @@ The genesis crate contains types related to chain genesis. -This section contains in-depth sections on building with [`op-alloy-genesis`][op-alloy-genesis] crate types. +This section contains in-depth sections on building with [`op-alloy-genesis`][genesis] crate types. - [The Rollup Config](./rollup-config.md) - [The System Config](./system-config.md) -[op-alloy-genesis]: https://crates.io/crates/op-alloy-genesis +{{#include ../links.md}} diff --git a/book/src/building/genesis/rollup-config.md b/book/src/building/genesis/rollup-config.md index 8bde48ffd..72fc9aa9a 100644 --- a/book/src/building/genesis/rollup-config.md +++ b/book/src/building/genesis/rollup-config.md @@ -2,7 +2,8 @@ Rollup configurations are a consensus construct used to configure an Optimism Consensus client. When an OP Stack chain is deployed into production or consensus nodes are configured to sync the chain, -certain consensus parameters can be configured. These parameters are defined in the [OP Stack specs][config]. +certain consensus parameters can be configured. These parameters are defined in the +[OP Stack specs][spec-configurability]. Consensus parameters are consumed by OP Stack software through the `RollupConfig` type defined in the [`op-alloy-genesis`][genesis] crate. @@ -30,9 +31,7 @@ the following. - `BASE_MAINNET_CONFIG` - `BASE_SEPOLIA_CONFIG` + -[rcid]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/rollup/fn.rollup_config_from_chain_id.html -[rc]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/rollup/struct.RollupConfig.html -[genesis]: https://crates.io/crates/op-alloy-genesis -[config]: https://specs.optimism.io/protocol/configurability.html +{{#include ../links.md}} diff --git a/book/src/building/genesis/system-config.md b/book/src/building/genesis/system-config.md index 10cf129f8..c8b1752d2 100644 --- a/book/src/building/genesis/system-config.md +++ b/book/src/building/genesis/system-config.md @@ -4,29 +4,27 @@ The system configuration is a set of configurable chain parameters defined in a contract on L1. These parameters can be changed through the system config contract, emitting events that are picked up by the [rollup node derivation process][derivation]. To dive deeper -into the System Config, visit the [OP Stack Specifications][specs]. +into the System Config, visit the +[OP Stack Specifications][system-config-specs]. ## `SystemConfig` Type -The [`SystemConfig`][sc] type is defined in [`op-alloy-genesis`][genesis]. +The [`SystemConfig`][system-config] type is defined in +[`op-alloy-genesis`][genesis]. -Parameters defined in the [`SystemConfig`][sc] are expected to be updated -through L1 receipts, using the [`update_with_receipts`][update] method. +Parameters defined in the [`SystemConfig`][system-config] are expected to be +updated through L1 receipts, using the [`update_with_receipts`][update] method. ## Holocene Updates -The [Holocene Hardfork][holocene] introduced an update to the [`SystemConfig`][sc] -type, adding EIP-1559 parameters to the config. - -The [`SystemConfig`][sc] type in [`op-alloy-genesis`][genesis] provides a method -called [`eip_1559_params`][eip] that returns the EIP-1559 parameters encoded as -a [`B64`][b64]. - -[holocene]: https://specs.optimism.io/protocol/holocene/overview.html -[b64]: https://docs.rs/alloy-primitives/latest/alloy_primitives/aliases/type.B64.html -[eip]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/system/struct.SystemConfig.html#method.eip_1559_params -[update]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/system/struct.SystemConfig.html#method.update_with_receipts -[sc]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/system/struct.SystemConfig.html -[specs]: https://specs.optimism.io/protocol/system-config.html#system-config -[derivation]: https://specs.optimism.io/protocol/derivation.html -[genesis]: https://crates.io/crates/op-alloy-genesis +The [Holocene Hardfork][holocene] introduced an update to the +[`SystemConfig`][system-config] type, adding EIP-1559 parameters to the config. + +The [`SystemConfig`][system-config] type in [`op-alloy-genesis`][genesis] provides +a method called [`eip_1559_params`][eip] that returns the EIP-1559 parameters +encoded as a [`B64`][b64]. + + + + +{{#include ../links.md}} diff --git a/book/src/building/rollup-configs.md b/book/src/building/rollup-configs.md index a96069699..72fc9aa9a 100644 --- a/book/src/building/rollup-configs.md +++ b/book/src/building/rollup-configs.md @@ -2,7 +2,8 @@ Rollup configurations are a consensus construct used to configure an Optimism Consensus client. When an OP Stack chain is deployed into production or consensus nodes are configured to sync the chain, -certain consensus parameters can be configured. These parameters are defined in the [OP Stack specs][config]. +certain consensus parameters can be configured. These parameters are defined in the +[OP Stack specs][spec-configurability]. Consensus parameters are consumed by OP Stack software through the `RollupConfig` type defined in the [`op-alloy-genesis`][genesis] crate. @@ -30,9 +31,7 @@ the following. - `BASE_MAINNET_CONFIG` - `BASE_SEPOLIA_CONFIG` + -[rcid]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/rollup/fn.rollup_config_from_chain_id.html -[rc]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/rollup/struct.RollupConfig.html -[genesis]: https://crates.io/crates/op-alloy-genesis -[config]: https://specs.optimism.io/protocol/configurability.html \ No newline at end of file +{{#include ../links.md}} diff --git a/book/src/links.md b/book/src/links.md index d672a4bd1..917dee377 100644 --- a/book/src/links.md +++ b/book/src/links.md @@ -13,25 +13,63 @@ [op-alloy-rpc-types-engine]: https://crates.io/crates/op-alloy-rpc-types-engine [op-alloy-rpc-types]: https://crates.io/crates/op-alloy-rpc-types - + -[op-stack]: https://github.com/ethereum-optimism/optimism -[op-program]: https://github.com/ethereum-optimism/optimism/tree/develop/op-program -[cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon -[cannon-rs]: https://github.com/anton-rs/cannon-rs -[asterisc]: https://github.com/ethereum-optimism/asterisc +[genesis]: https://crates.io/crates/op-alloy-genesis +[rc]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/rollup/struct.RollupConfig.html +[rcid]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/rollup/fn.rollup_config_from_chain_id.html +[eip]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/system/struct.SystemConfig.html#method.eip_1559_params +[update]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/system/struct.SystemConfig.html#method.update_with_receipts +[system-config]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/system/struct.SystemConfig.html + + + + +[consensus]: https://crates.io/crates/op-alloy-consensus +[odr]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/struct.OpDepositReceipt.html +[ore]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpReceiptEnvelope.html +[op-block]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/type.OpBlock.html +[ty]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpTxType.html +[envelope]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpTxEnvelope.html + + + +[holocene]: https://specs.optimism.io/protocol/holocene/overview.html +[hardforks]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/hardforks/struct.Hardforks.html +[fjord]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/hardforks/struct.Hardforks.html#method.fjord_txs +[ecotone]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/hardforks/struct.Hardforks.html#method.ecotone_txs + + + +[specs]: https://specs.optimism.io/protocol/deposits.html +[deposit]: https://specs.optimism.io/protocol/deposits.html +[derivation]: https://specs.optimism.io/protocol/derivation.html [fp-specs]: https://specs.optimism.io/experimental/fault-proof/index.html +[spec-configurability]: https://specs.optimism.io/protocol/configurability.html +[system-config-specs]: https://specs.optimism.io/protocol/system-config.html#system-config [fpp-specs]: https://specs.optimism.io/experimental/fault-proof/index.html#fault-proof-program [preimage-specs]: https://specs.optimism.io/experimental/fault-proof/index.html#pre-image-oracle [cannon-specs]: https://specs.optimism.io/experimental/fault-proof/cannon-fault-proof-vm.html#cannon-fault-proof-virtual-machine [l2-output-root]: https://specs.optimism.io/protocol/proposals.html#l2-output-commitment-construction -[op-succinct]: https://github.com/succinctlabs/op-succinct + + + + [revm]: https://github.com/bluealloy/revm +[2718]: https://eips.ethereum.org/EIPS/eip-2718 +[cannon-rs]: https://github.com/anton-rs/cannon-rs +[asterisc]: https://github.com/ethereum-optimism/asterisc +[op-stack]: https://github.com/ethereum-optimism/optimism +[op-succinct]: https://github.com/succinctlabs/op-succinct +[op-program]: https://github.com/ethereum-optimism/optimism/tree/develop/op-program +[cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon [alloy]: https://github.com/alloy-rs/alloy [op-alloy]: https://github.com/alloy-rs/op-alloy +[b64]: https://docs.rs/alloy-primitives/latest/alloy_primitives/aliases/type.B64.html +[tx-envelope]: https://docs.rs/alloy-consensus/latest/alloy_consensus/transaction/enum.TxEnvelope.html From ad2b19733463725914407cb5fe946e1f011fd4a0 Mon Sep 17 00:00:00 2001 From: refcell Date: Mon, 4 Nov 2024 19:24:49 -0500 Subject: [PATCH 2/2] fix: link imports --- book/src/building/genesis/README.md | 2 +- book/src/building/genesis/rollup-config.md | 2 +- book/src/building/genesis/system-config.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/book/src/building/genesis/README.md b/book/src/building/genesis/README.md index 9263b5e08..aa590fd58 100644 --- a/book/src/building/genesis/README.md +++ b/book/src/building/genesis/README.md @@ -9,4 +9,4 @@ This section contains in-depth sections on building with [`op-alloy-genesis`][ge -{{#include ../links.md}} +{{#include ../../links.md}} diff --git a/book/src/building/genesis/rollup-config.md b/book/src/building/genesis/rollup-config.md index 72fc9aa9a..23dd4c619 100644 --- a/book/src/building/genesis/rollup-config.md +++ b/book/src/building/genesis/rollup-config.md @@ -34,4 +34,4 @@ the following. -{{#include ../links.md}} +{{#include ../../links.md}} diff --git a/book/src/building/genesis/system-config.md b/book/src/building/genesis/system-config.md index c8b1752d2..d526c03c1 100644 --- a/book/src/building/genesis/system-config.md +++ b/book/src/building/genesis/system-config.md @@ -27,4 +27,4 @@ encoded as a [`B64`][b64]. -{{#include ../links.md}} +{{#include ../../links.md}}