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

chore: add missing doc link for parent_beacon_block_root #244

Merged
Merged
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
10 changes: 6 additions & 4 deletions crates/rpc-engine-types/src/optimism.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ pub struct OptimismPayloadAttributes {
pub gas_limit: Option<u64>,
}

/// This structure maps on the ExecutionPayloadV3 structure of the beacon chain spec.
/// This structure maps on the ExecutionPayloadV3 structure of the beacon chain spec to be used on
/// Optimism.
///
/// See also: <https://github.com/ethereum/execution-apis/blob/6709c2a795b707202e93c4f2867fa0bf2640a84f/src/engine/shanghai.md#executionpayloadv2>
/// See also: [Ethereum exeuction payload v2](https://github.com/ethereum/execution-apis/blob/6709c2a795b707202e93c4f2867fa0bf2640a84f/src/engine/shanghai.md#executionpayloadv2), [Ethereum exeuction payload v3](https://github.com/ethereum/execution-apis/blob/fe8e13c288c592ec154ce25c534e26cb7ce0530d/src/engine/cancun.md#ExecutionPayloadV3), [Optimism exeuction payload v3](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/exec-engine.md#engine_getpayloadv3)
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OptimismExecutionPayloadV3 {
Expand All @@ -35,15 +36,16 @@ pub struct OptimismExecutionPayloadV3 {
pub payload_inner: ExecutionPayloadV2,

/// Array of hex [`u64`] representing blob gas used, enabled with V3
/// See <https://github.com/ethereum/execution-apis/blob/fe8e13c288c592ec154ce25c534e26cb7ce0530d/src/engine/cancun.md#ExecutionPayloadV3>
/// See [Ethereum exeuction payload v3](https://github.com/ethereum/execution-apis/blob/fe8e13c288c592ec154ce25c534e26cb7ce0530d/src/engine/cancun.md#ExecutionPayloadV3)
#[serde(with = "alloy_rpc_types::serde_helpers::u64_hex")]
pub blob_gas_used: u64,
/// Array of hex[`u64`] representing excess blob gas, enabled with V3
/// See <https://github.com/ethereum/execution-apis/blob/fe8e13c288c592ec154ce25c534e26cb7ce0530d/src/engine/cancun.md#ExecutionPayloadV3>
/// See [Ethereum exeuction payload v3](https://github.com/ethereum/execution-apis/blob/fe8e13c288c592ec154ce25c534e26cb7ce0530d/src/engine/cancun.md#ExecutionPayloadV3)
#[serde(with = "alloy_rpc_types::serde_helpers::u64_hex")]
pub excess_blob_gas: u64,

/// Ecotone parent beacon block root
/// See [Optimism exeuction payload v3](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/exec-engine.md#engine_getpayloadv3)
pub parent_beacon_block_root: B256,
}

Expand Down
Loading