feat(op-consensus): `op-alloy-consensus` #4

clabby · 2024-04-13T02:25:11Z

Overview

Adds a periphery crate for alloy-consensus, op-alloy-consensus, that contains OP-specific types for the TxEnvelope (to include TxDeposit) as well as the Receipt + ReceiptEnvelope. For all unmodified types, such as the Header, consumers should use alloy-consensus.

Note

Blocked by alloy-rs/alloy#529, will update the alloy dependency after this has been merged.

mattsse

great start,

we should reuse as much as possible from alloy-consensus

clabby · 2024-04-13T16:12:10Z

great start,

we should reuse as much as possible from alloy-consensus

Thanks - this should be the minimal amount we need to port, without changing the upstream API of alloy-consensus. We can re-use TxLegacy, TxEip2930, TxEip1559, and TxEip4844, but would need to expose several of their private functions in alloy-consensus:

fields_len
decode_signed_fields
encode_with_signature

Update: alloy-rs/alloy#529

crates/op-consensus/src/transaction/optimism.rs

mattsse

this is great,

only have two questions re receipt stuff

crates/op-consensus/src/receipt/mod.rs

mattsse · 2024-04-16T14:34:55Z

crates/op-consensus/src/receipt/envelope.rs

+    ///
+    /// [deposit]: https://specs.optimism.io/protocol/deposits.html
+    #[cfg_attr(feature = "serde", serde(rename = "0x7E", alias = "0x7E"))]
+    Deposit(OpReceiptWithBloom<T>),


hmm, only this variant needs the Op specific receipt type, right?

the others could reuse the the alloy-consensus one?

Yeah, only this variant needs it. Decided to use all OpReceiptWithBlooms to avoid type conversion within as_receipt_with_bloom + as_receipt.

Technically, all of the receipts within OP consensus do use this format, though the extra deposit_nonce + deposit_receipt_version fields are omitted from the RLP if they don't exist. Could reuse the ReceiptWithBloom<T> type for others -- would you rather have the type conversions?

gakonst · 2024-04-13T20:34:03Z

crates/op-consensus/src/receipt/envelope.rs

+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(tag = "type"))]
+#[non_exhaustive]
+pub enum OpReceiptEnvelope<T = Log> {


PTAL at the review here w.r.t type duplication between alloy upstream and op-alloy #2

it should be possible to wrap the internal receipt type, I would think? maybe not

mattsse

hmm, I'd prefer if we could reuse the alloy-consensus receipt envelope type or even the entire variant and then only add an additional deposit variant

adding pub struct OpReceipt<T = Log> { doesn't make much sense to me

mattsse · 2024-04-18T11:17:23Z

crates/op-consensus/src/receipt/envelope.rs

+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(tag = "type"))]
+#[non_exhaustive]
+pub enum OpReceiptEnvelope<T = Log> {


I think we should just reuse the regular alloy consensus types here

mattsse · 2024-04-18T11:18:50Z

crates/op-consensus/src/receipt/receipts.rs

+#[derive(Clone, Debug, PartialEq, Eq, Default)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
+pub struct OpReceipt<T = Log> {


this should be OpDepositReceipt
which wraps the alloy-consensus receipt and adds extra fields for deposit

prestwich · 2024-04-23T14:35:15Z

adds a little work for you, but it's all easy:
alloy-rs/alloy#477

mattsse · 2024-06-12T14:37:26Z

superseded by #8

refcell added 3 commits April 10, 2024 14:26

feat(consensus): op-consensus

6066171

feat(consensus): op-consensus

cfbeee9

feat(op-consensus): add optimism deposit tx type

1eb8cff

clabby requested review from gakonst and mattsse as code owners April 13, 2024 02:25

clabby marked this pull request as draft April 13, 2024 02:26

clabby force-pushed the refcell/consensus-port branch 4 times, most recently from e6f9bd5 to 3c16cb7 Compare April 13, 2024 02:39

clabby marked this pull request as ready for review April 13, 2024 02:47

clabby force-pushed the refcell/consensus-port branch from 3c16cb7 to 3e6c21c Compare April 13, 2024 02:49

feat(op-consensus): Trim and complete OP modifications

4ae4b22

clabby force-pushed the refcell/consensus-port branch from 3e6c21c to 4ae4b22 Compare April 13, 2024 02:58

mattsse reviewed Apr 13, 2024

View reviewed changes

clabby added 2 commits April 13, 2024 12:24

Use upstreamed Signed + SignableTransaction

af3099b

Add deposit receipt roundtrip RLP tests

6c67854

clabby force-pushed the refcell/consensus-port branch 3 times, most recently from 2fb8518 to fbe2cdd Compare April 13, 2024 20:28

Use upstream Ethereum transaction types from alloy-consensus

fbe40e6

clabby force-pushed the refcell/consensus-port branch 4 times, most recently from b15ea35 to aa904b4 Compare April 13, 2024 21:00

clabby commented Apr 13, 2024

View reviewed changes

crates/op-consensus/src/transaction/optimism.rs Outdated Show resolved Hide resolved

deposit fn in OpTypedTransaction

2d72c8e

clabby force-pushed the refcell/consensus-port branch from aa904b4 to 2d72c8e Compare April 13, 2024 21:02

Use upstream alloy

bb22136

clabby force-pushed the refcell/consensus-port branch from 506dcad to bb22136 Compare April 16, 2024 14:24

mattsse requested changes Apr 16, 2024

View reviewed changes

Inherit TxReceipt trait

74ed633

gakonst reviewed Apr 16, 2024

View reviewed changes

mattsse requested changes Apr 16, 2024

View reviewed changes

mattsse requested changes Apr 18, 2024

View reviewed changes

refcell mentioned this pull request Apr 27, 2024

dep(op-alloy): Merge in OP Consensus Types anton-rs/kona#151

Closed

refcell changed the base branch from main to refcell/consensus-port May 20, 2024 17:50

refcell changed the base branch from refcell/consensus-port to main May 20, 2024 17:51

refcell mentioned this pull request May 20, 2024

feat(consensus): op-alloy-consensus #8

Merged

mattsse closed this Jun 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(op-consensus): `op-alloy-consensus` #4

feat(op-consensus): `op-alloy-consensus` #4

clabby commented Apr 13, 2024 •

edited

Loading

mattsse left a comment

clabby commented Apr 13, 2024 •

edited

Loading

mattsse left a comment

mattsse Apr 16, 2024

clabby Apr 16, 2024

gakonst Apr 13, 2024

mattsse left a comment

mattsse Apr 18, 2024

mattsse Apr 18, 2024

prestwich commented Apr 23, 2024

mattsse commented Jun 12, 2024

feat(op-consensus): op-alloy-consensus #4

feat(op-consensus): op-alloy-consensus #4

Conversation

clabby commented Apr 13, 2024 • edited Loading

Overview

mattsse left a comment

Choose a reason for hiding this comment

clabby commented Apr 13, 2024 • edited Loading

mattsse left a comment

Choose a reason for hiding this comment

mattsse Apr 16, 2024

Choose a reason for hiding this comment

clabby Apr 16, 2024

Choose a reason for hiding this comment

gakonst Apr 13, 2024

Choose a reason for hiding this comment

mattsse left a comment

Choose a reason for hiding this comment

mattsse Apr 18, 2024

Choose a reason for hiding this comment

mattsse Apr 18, 2024

Choose a reason for hiding this comment

prestwich commented Apr 23, 2024

mattsse commented Jun 12, 2024

feat(op-consensus): `op-alloy-consensus` #4

feat(op-consensus): `op-alloy-consensus` #4

clabby commented Apr 13, 2024 •

edited

Loading

clabby commented Apr 13, 2024 •

edited

Loading