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(book): Load Rollup Config Example #224

Merged
merged 2 commits into from
Nov 6, 2024
Merged

chore(book): Load Rollup Config Example #224

merged 2 commits into from
Nov 6, 2024

Conversation

refcell
Copy link
Collaborator

@refcell refcell commented Nov 4, 2024

Description

Loading a rollup config example.

@refcell
Copy link
Collaborator Author

refcell commented Nov 4, 2024

📚 $\text{Stack Overview}$

Pulls submitted in this stack:

This comment was automatically generated by st.

@refcell refcell self-assigned this Nov 4, 2024
@refcell refcell added the A-book Area: mdbook label Nov 4, 2024
@refcell refcell mentioned this pull request Nov 4, 2024
@mattsse mattsse added this pull request to the merge queue Nov 6, 2024
Merged via the queue into main with commit edc8247 Nov 6, 2024
19 checks passed
@mattsse mattsse deleted the rf/chore/examples branch November 6, 2024 11:14
PinelliaC added a commit to mantle-xyz/op-alloy that referenced this pull request Mar 4, 2025
* chore(consensus): Small Cleanup (alloy-rs#180)

### Description

Cleans up `op-alloy-consensus`, moving tests to their respective
modules.

* feat(genesis): EIP 1559 System Config Accessor (alloy-rs#179)

### Description

Introduces an accessor method for the `SystemConfig` to get the encoded
EIP 1559 params.

* chore: bump alloy (alloy-rs#178)

* add arbitrary attr (alloy-rs#182)

close alloy-rs#158

* feat(rpc-types): `{Try}From` impl for `OpTransactionReceipt` + `Transaction` -> consensus types (alloy-rs#183)

## Overview

Adds `{Try}From` implementations for the RPC receipt / transaction type
into the `op-alloy-consensus` `OpReceiptEnvelope` + `OpTxEnvelope`
counterparts.

closes alloy-rs#181

* chore: release 0.5.1 (alloy-rs#184)

### Description

Releases `0.5.1`.

Unblocks @clabby from refactoring `kona-host` to remove the `debug_*`
endpoints since alloy-rs#183 was
merged.

* feat(protocol): Batch Type (alloy-rs#186)

### Description

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Batch Validity (alloy-rs#187)

### Description

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

This PR introduces the `BatchValidity` type.

* feat(protocol): SingleBatch Type (alloy-rs#188)

### Description

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

This PR introduces the `SingleBatch` type.

* feat(protocol): BatchValidationProvider (alloy-rs#189)

### Description

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

This PR introduces a validation trait that is used for span batch
validity checks.

* feat(protocol): Batch Error Types (alloy-rs#190)

### Description

Ports batch error types to `op-alloy-protocol`.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Batch Utilities (alloy-rs#191)

### Description

Ports batch utilities to `op-alloy-protocol`.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Span Batch Element (alloy-rs#193)

### Description

Ports the span batch element type to `op-alloy-protocol`.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* chore(consensus): Upstream Receipt Constructor (alloy-rs#165)

### Description

Small PR to upstream a [receipt constructor from
kona](https://github.com/anton-rs/kona/blob/main/crates/executor/src/util.rs#L11).

* feat(protocol): Span Batch Bits (alloy-rs#194)

### Description

Ports the span batch bits to `op-alloy-protocol`.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Batch TX Data (alloy-rs#195)

### Description

Ports the batch transaction data types to `op-alloy-protocol`.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Span Batch Transactions (alloy-rs#196)

### Description

Ports the batch transactions to `op-alloy-protocol`.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Span Batch Type (alloy-rs#197)

### Description

Ports the Span Batch Type to `op-alloy-protocol`. A follow-on pr will
implement batch validation and the prefix check.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Span Batch Validity Checks (alloy-rs#198)

### Description

Ports span batch validity checks to `op-alloy-protocol`.

### Provenance

Part of a port migrating the batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* feat(protocol): Batch (alloy-rs#200)

### Description

Ports the remaining batch types to `op-alloy-protocol`.

### Provenance

Last PR in the stack to migrate batch types from `kona-derive` to
`op-alloy`. See
[`kona#695`](op-rs/kona#695).

* chore(workspace): Import Touchups (alloy-rs#199)

### Description

Small touchups to dependencies, hoisting dep versioning to the workspace
root.

* chore: Release 0.5.2 (alloy-rs#201)

### Description

Release `op-alloy-*` `v0.5.2` including ported batch types, improved
crate hygiene, and more.

* feat: Book (alloy-rs#206)

### Description

Introduces an mdbook hosted at https://alloy-rs.github.io/op-alloy.

Also adds a github action workflow to publish the book.

* feat: README (alloy-rs#207)

### Description

Updates the `op-alloy` readme, following the layout of
[alloy](https://github.com/alloy-rs/alloy).

* feat: Book Setup (alloy-rs#208)

### Description

Sets up the initial structure for the `op-alloy` book.

* feat(book): Genesis - Rollup Config (alloy-rs#209)

### Description

Outlines the `RollupConfig` type in `op-alloy-genesis`.

* feat: `op-alloy` meta crate (alloy-rs#210)

### Description

Introduces a meta crate like `alloy` that re-exports all `op-alloy-*`
crates behind respective feature flags.

* feat(book): Genesis - System Config (alloy-rs#211)

### Description

Adds docs for the `SystemConfig` and structures the book out a bit.

* feat(book): Consensus (alloy-rs#212)

### Description

Documents the `op-alloy-consensus` crate in the mdbook.

* fix(book): Missing READMEs (alloy-rs#213)

### Description

Fixes the mdbook missing `READMEs`

* feat: `OpTransactionRequest` (alloy-rs#215)

<!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

Closes alloy-rs#27

To be able to replace `UnsingedTx` and `TxEnvelope` on Optimism network
with op-consensus types, we need a op-specific tx builder.

## Solution

Add `OpTransactionBuilder` which is a wrapper around
`TransactionBuilder`. It intentionally does not have any direct methods
allowing to set EIP-4844 fields, however they can still be set through
`AsMut` or during deserialization.

When building typed transaction, eip-4844 transactions are getting
converted to eip-1559

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

* fix: ci powerset (alloy-rs#214)

### Description

Fixes the feature powerset in ci to exclude `op-alloy` due to
combinatorial overflow.

* fix(ci): Remove Docs gh-page publish (alloy-rs#216)

### Description

Removes the publishing of basic docs to gh-pages. There's now a nice
mdbook that's published by the books.yml workflow.

* chore(book): Fix Doc Links (alloy-rs#218)

### Description

Fixes links doc links.

* feat: add jsonrpsee trait for SuperchainSignal (alloy-rs#217)

related issues  paradigmxyz/reth#12275
<!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

<!--
Explain the context and why you're making that change. What is the
problem
you're trying to solve? In some cases there is not a problem and this
can be
thought of as being the motivation for your change.
-->

## Solution

<!--
Summarize the solution and provide any necessary context needed to
understand
the code change.
-->

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

---------

Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>

* chore(ci): Use Justfile Targets in Github Actions (alloy-rs#219)

### Description

Small PR that re-jiggers github actions to use justfile targets for
easier local reproducibility.

* chore(book): Consensus Docs (alloy-rs#222)

### Description

Re-work the `op-alloy-consensus` docs.

* chore(book): Genesis Docs (alloy-rs#223)

### Description

Touches up the genesis docs.

* fix(book): Small Book Touchups (alloy-rs#220)

### Description

Touches up the mdbook and the repo readme to include an active
development section.

* chore(book): Load Rollup Config Example (alloy-rs#224)

### Description

Loading a rollup config example.

* [wip] feat: bump alloy (alloy-rs#205)

<!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

Bumps alloy, alloy-core and alloy-eip7702.

Code changes: 
- alloy-rs/alloy#1496 changed transaction
encoding API, encoding functions are now prefixed with `rlp`,`eip2718`
or `network`. I've updated `TxDeposit` to have methods following this
pattern
- alloy-rs/core#776 updated signature type to
avoid using `Parity` generic and instead just keep a boolean for parity
byte. The motivation is to have more correctness in encoding and data
structure. Before that it was possible to construct `Signed<TxLegacy>`
where transaction chain_id is `Some`, but the parity would not follow
EIP-155.
    
   This required a few changes to `SpanBatchTransactions` type:
- `encode_y_parity_bits` and `encode_tx_sigs_rs` are merged into single
`encode_tx_sigs` which firstly encodes parity bits and then `rs` values.
Same was done for decoding methods
- `recover_v` method is removed. instead, we now pass the `is_protected`
flag down to `SpanBatchLegacyTransactionData` and only set `chain_id` to
`Some` when `is_protected` is true

Blocked by minor releases for alloy, core and revm

## Solution

<!--
Summarize the solution and provide any necessary context needed to
understand
the code change.
-->

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

* feat: add holocene extradata fn (alloy-rs#233)

~~blocked by alloy-rs#205~~

ported from reth

* chore: release 0.6.0

* chore(book): Protocol Docs (alloy-rs#225)

### Description

Makes progress on the book section for working with `op-alloy-protocol`
types.

* fix(book): Links Imports (alloy-rs#227)

### Description

Fixes links doc import.

* chore(book): RPC Types (alloy-rs#228)

### Description

Adds small docs for `op-alloy-rpc-types`

* feat(book): Engine RPC Types (alloy-rs#229)

### Description

Adds `op-alloy-rpc-types-engine` docs to the book.

* chore(book): Consolidate Links (alloy-rs#230)

### Description

Consolidates links into the `links.md` doc.

* chore(rpc-types): Clean up Exports (alloy-rs#231)

### Description

Small PR to clean up the exports of `op-alloy-rpc-types`.

* fix(protocol): Batch Decoding (alloy-rs#235)

### Description

Breaks out the small batch decoding fix from alloy-rs#234.

* feat: add fn for decoded 1559 params (alloy-rs#236)

smol helper

* chore: move eip1559 impls (alloy-rs#237)

move to consensus, make them reusable

* Release: v0.6.1 (alloy-rs#238)

* chore: release 0.6.2

* chore: Bump Alloy Deps (alloy-rs#239)

### Description

Bumps alloy deps to `0.6.1`.

* feat: bump alloy (alloy-rs#240)

      <!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

<!--
Explain the context and why you're making that change. What is the
problem
you're trying to solve? In some cases there is not a problem and this
can be
thought of as being the motivation for your change.
-->

## Solution

<!--
Summarize the solution and provide any necessary context needed to
understand
the code change.
-->

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

* chore: release 0.6.3

* fix(consensus): fix arbitrary impl for `OpTxType` (alloy-rs#242)

<!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

Bug arbitrary impl

## Solution

Add missing `OpTxType::Eip7702` to `OpTxType::ALL` list

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

* fix(consensus): add conversion for `OpTxType::Eip7702` (alloy-rs#244)

<!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

Broken decoding for eip7702

## Solution

Adds conversion from u8 to `OpTxType::Eip7702`

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

* chore: add is dynamic fee (alloy-rs#245)

* chore: release 0.6.4

* feat: add nonce to RPC transaction (alloy-rs#246)

<!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

ref paradigmxyz/reth#12474

We need a separate `deposit_nonce` to account for deposit transaction
responses which have it while it's not present in inner envelope.

## Solution

Adds `nonce` field to `OptionalFields` helper. It would get deserialized
only if envelope did not consume it and serialized only if present and
inner envelope is a deposit

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

* feat: wrap `TxDeposit` into `Sealed` in `OpTxEnvelope` (alloy-rs#247)

<!--
Thank you for your Pull Request. Please provide a description above and
review
the requirements below.

Bug fixes and new features should include tests.

Contributors guide:
https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md

The contributors guide includes instructions for running rustfmt and
building the
documentation.
-->

<!-- ** Please select "Allow edits from maintainers" in the PR Options
** -->

## Motivation

ref https://t.me/paradigm_reth/36099

Makes envelope more consistend by making all variants hold a hash

## Solution

<!--
Summarize the solution and provide any necessary context needed to
understand
the code change.
-->

## PR Checklist

- [ ] Added Tests
- [ ] Added Documentation
- [ ] Breaking changes

* chore: add deserde test (alloy-rs#248)

* chore: bump alloy 064 (alloy-rs#249)

* chore: release 0.6.5

* refactor: support mantle

* fix: correct token ratio field name and update L1 origin type

* update alloy version to 0.11.1

* fix: sepolia batch_inbox_address (#6)

---------

Co-authored-by: refcell <abigger87@gmail.com>
Co-authored-by: Oliver <onbjerg@users.noreply.github.com>
Co-authored-by: Joseph Zhao <65984904+programskillforverification@users.noreply.github.com>
Co-authored-by: clabby <ben@clab.by>
Co-authored-by: Arsenii Kulikov <klkvrr@gmail.com>
Co-authored-by: Hoa Nguyen <hoa@notional.ventures>
Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
Co-authored-by: Emilia Hane <elsaemiliaevahane@gmail.com>
Co-authored-by: PinelliaC <wylbzc4928@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-book Area: mdbook
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants