Skip to content
This repository was archived by the owner on Feb 21, 2025. It is now read-only.

Commit bfbbd98

Browse files
committed
Migrate alloy-rs/op-alloy-protocol->op-rs/maili-protocol & alloy-rs/op-alloy-provider->op-rs/maili-provider
1 parent 0eda9ed commit bfbbd98

File tree

131 files changed

+200
-13738
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+200
-13738
lines changed

.github/ISSUE_TEMPLATE/BUG-FORM.yml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,15 @@ body:
1515
description: What component is the bug in?
1616
multiple: true
1717
options:
18-
- consensus
19-
- network
20-
- genesis
2118
- protocol
2219
- provider
23-
- op-alloy
24-
- registry
25-
- rpc-jsonrpsee
26-
- rpc-types
27-
- rpc-types-engine
2820
- other
2921
validations:
3022
required: true
3123
- type: input
3224
attributes:
33-
label: What version of op-alloy are you on?
34-
placeholder: "Run `cargo tree | grep op-alloy` and paste the output here"
25+
label: What version of maili are you on?
26+
placeholder: "Run `cargo tree | grep maili` and paste the output here"
3527
- type: dropdown
3628
attributes:
3729
label: Operating System

.github/ISSUE_TEMPLATE/FEATURE-FORM.yml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,8 @@ body:
1313
description: What crate is the feature for?
1414
multiple: true
1515
options:
16-
- consensus
17-
- network
18-
- genesis
1916
- protocol
2017
- provider
21-
- op-alloy
22-
- registry
23-
- rpc-jsonrpsee
24-
- rpc-types
25-
- rpc-types-engine
2618
- other
2719
validations:
2820
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ the requirements below.
44
55
Bug fixes and new features should include tests.
66
7-
Contributors guide: https://github.com/alloy-rs/core/blob/main/CONTRIBUTING.md
7+
Contributors guide: https://github.com/op-rs/maili/blob/main/CONTRIBUTING.md
88
99
The contributors guide includes instructions for running rustfmt and building the
1010
documentation.

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ jobs:
8585
cache-on-failure: true
8686
- name: cargo hack
8787
run: |
88-
cargo hack build --workspace --target wasm32-unknown-unknown --exclude op-alloy-network --exclude op-alloy-rpc-jsonrpsee --exclude op-alloy-provider
88+
cargo hack build --workspace --target wasm32-unknown-unknown --exclude maili-provider
8989
9090
wasm-wasi:
9191
runs-on: ubuntu-latest
@@ -103,7 +103,7 @@ jobs:
103103
cache-on-failure: true
104104
- name: cargo hack
105105
run: |
106-
cargo hack build --workspace --target wasm32-wasip1 --exclude op-alloy-network --exclude op-alloy-rpc-types --exclude op-alloy-provider
106+
cargo hack build --workspace --target wasm32-wasip1 --exclude maili-provider
107107
108108
no-std:
109109
runs-on: ubuntu-latest

Cargo.toml

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ members = ["crates/*"]
33
resolver = "2"
44

55
[workspace.package]
6-
version = "0.9.0"
6+
version = "0.1.0"
77
edition = "2021"
88
rust-version = "1.81"
99
authors = ["Alloy Contributors"]
1010
license = "MIT OR Apache-2.0"
11-
homepage = "https://github.com/alloy-rs/op-alloy"
12-
repository = "https://github.com/alloy-rs/op-alloy"
11+
homepage = "https://github.com/op-rs/maili"
12+
repository = "https://github.com/op-rs/maili"
1313
exclude = ["benches/", "tests/"]
1414

1515
[workspace.lints.rustdoc]
@@ -36,15 +36,17 @@ rustdoc-args = ["--cfg", "docsrs"]
3636

3737
[workspace.dependencies]
3838
# Workspace
39-
op-alloy-genesis = { version = "0.9.0", path = "crates/genesis", default-features = false }
40-
op-alloy-protocol = { version = "0.9.0", path = "crates/protocol", default-features = false }
41-
op-alloy-consensus = { version = "0.9.0", path = "crates/consensus", default-features = false }
42-
op-alloy-network = { version = "0.9.0", path = "crates/network", default-features = false }
43-
op-alloy-provider = { version = "0.9.0", path = "crates/provider", default-features = false }
44-
op-alloy-registry = { version = "0.9.0", path = "crates/registry", default-features = false }
45-
op-alloy-rpc-types = { version = "0.9.0", path = "crates/rpc-types", default-features = false }
46-
op-alloy-rpc-jsonrpsee = { version = "0.9.0", path = "crates/rpc-jsonrpsee", default-features = false }
47-
op-alloy-rpc-types-engine = { version = "0.9.0", path = "crates/rpc-types-engine", default-features = false }
39+
maili-protocol = { version = "0.1.0", path = "crates/protocol", default-features = false }
40+
maili-provider = { version = "0.1.0", path = "crates/provider", default-features = false }
41+
42+
# OP-Alloy
43+
op-alloy-genesis = { version = "0.9.0", default-features = false }
44+
op-alloy-consensus = { version = "0.9.0", default-features = false }
45+
op-alloy-network = { version = "0.9.0", default-features = false }
46+
op-alloy-registry = { version = "0.9.0", default-features = false }
47+
op-alloy-rpc-types = { version = "0.9.0", default-features = false }
48+
op-alloy-rpc-jsonrpsee = { version = "0.9.0", default-features = false }
49+
op-alloy-rpc-types-engine = { version = "0.9.0", default-features = false }
4850

4951
# Alloy
5052
alloy-eips = { version = "0.9.2", default-features = false }

Justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ check:
5454

5555
# Runs `cargo hack check` against the workspace
5656
hack:
57-
cargo hack check --feature-powerset --no-dev-deps --exclude op-alloy --workspace
57+
cargo hack check --feature-powerset --no-dev-deps --workspace
5858

5959
# Updates the git submodule source
6060
source:

README.md

Lines changed: 21 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,31 @@
1-
# op-alloy
1+
# maili
22

3-
<a href="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml"><img src="https://github.com/alloy-rs/op-alloy/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
4-
<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
5-
<a href="https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
6-
<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
3+
<a href="https://github.com/op-rs/maili/actions/workflows/ci.yml"><img src="https://github.com/op-rs/maili/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
4+
<a href="https://github.com/op-rs/maili/blob/main/LICENSE-APACHE"><img src="https://img.shields.io/badge/License-APACHE-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
5+
<a href="https://github.com/op-rs/maili/blob/main/LICENSE-MIT"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
6+
<a href="https://op-rs.github.io/maili"><img src="https://img.shields.io/badge/Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
77

8-
Built on [Alloy][alloy], op-alloy connects applications to the OP Stack.
8+
OP Stack unique types and interfaces.
99

1010

1111
## Usage
1212

13-
The following crates are provided by `op-alloy`.
13+
The following crates are provided by `maili`.
1414

15-
- [`op-alloy-consensus`][op-alloy-consensus]
16-
- [`op-alloy-genesis`][op-alloy-genesis]
17-
- [`op-alloy-network`][op-alloy-network]
18-
- [`op-alloy-protocol`][op-alloy-protocol]
19-
- [`op-alloy-registry`][op-alloy-registry]
20-
- [`op-alloy-provider`][op-alloy-provider]
21-
- [`op-alloy-rpc-jsonrpsee`][op-alloy-rpc-jsonrpsee]
22-
- [`op-alloy-rpc-types-engine`][op-alloy-rpc-types-engine]
23-
- [`op-alloy-rpc-types`][op-alloy-rpc-types]
15+
- [`maili-protocol`][maili-protocol]
16+
- [`maili-provider`][maili-provider]
2417

2518

2619
## Development Status
2720

28-
`op-alloy` is currently in active development, and is not yet ready for use in production.
21+
`maili` is currently in active development, and is not yet ready for use in production.
2922

3023

3124
## Supported Rust Versions (MSRV)
3225

3326
The current MSRV (minimum supported rust version) is 1.81.
3427

35-
Unlike Alloy, op-alloy may use the latest stable release,
28+
Unlike Alloy, maili may use the latest stable release,
3629
to benefit from the latest features.
3730

3831
The MSRV is not increased automatically, and will be updated
@@ -41,7 +34,7 @@ only as part of a patch (pre-1.0) or minor (post-1.0) release.
4134

4235
## Contributing
4336

44-
op-alloy is built by open source contributors like you, thank you for improving the project!
37+
maili is built by open source contributors like you, thank you for improving the project!
4538

4639
A [contributing guide][contributing] is available that sets guidelines for contributing.
4740

@@ -51,25 +44,21 @@ linting rules and passes clippy.
5144

5245
## `no_std`
5346

54-
op-alloy is intended to be `no_std` compatible, initially for use in [kona][kona].
47+
maili is intended to be `no_std` compatible, initially for use in [kona][kona].
5548

5649
The following crates support `no_std`.
5750
Notice, provider crates do not support `no_std` compatibility.
5851

59-
- [`op-alloy-genesis`][op-alloy-genesis]
60-
- [`op-alloy-protocol`][op-alloy-protocol]
61-
- [`op-alloy-registry`][op-alloy-registry] (note: requires `serde`)
62-
- [`op-alloy-consensus`][op-alloy-consensus]
63-
- [`op-alloy-rpc-types`][op-alloy-rpc-types]
64-
- [`op-alloy-rpc-types-engine`][op-alloy-rpc-types-engine]
52+
- [`maili-protocol`][maili-protocol]
53+
- [`maili-provider`][maili-provider]
6554

6655
If you would like to add no_std support to a crate,
6756
please make sure to update [scripts/check_no_std.sh][check-no-std].
6857

6958

7059
## Credits
7160

72-
op-alloy is inspired by the work of several teams and projects, most notably [the Alloy project][alloy].
61+
maili implements the OP-unique spec, [op-alloy][op-alloy] is the glue that sticks OP to Ethereum.
7362

7463
This would not be possible without the hard work from open source contributors. Thank you.
7564

@@ -89,15 +78,8 @@ shall be dual licensed as above, without any additional terms or conditions.
8978
[check-no-std]: ./scripts/check_no_std.sh
9079

9180
[kona]: https://github.com/anton-rs/kona
92-
[alloy]: https://github.com/alloy-rs/alloy
93-
[contributing]: https://alloy-rs.github.io/op-alloy
94-
95-
[op-alloy-consensus]: https://crates.io/crates/op-alloy-consensus
96-
[op-alloy-genesis]: https://crates.io/crates/op-alloy-genesis
97-
[op-alloy-network]: https://crates.io/crates/op-alloy-network
98-
[op-alloy-protocol]: https://crates.io/crates/op-alloy-protocol
99-
[op-alloy-registry]: https://crates.io/crates/op-alloy-registry
100-
[op-alloy-provider]: https://crates.io/crates/op-alloy-provider
101-
[op-alloy-rpc-jsonrpsee]: https://crates.io/crates/op-alloy-rpc-jsonrpsee
102-
[op-alloy-rpc-types-engine]: https://crates.io/crates/op-alloy-rpc-types-engine
103-
[op-alloy-rpc-types]: https://crates.io/crates/op-alloy-rpc-types
81+
[op-alloy]: https://github.com/alloy-rs/op-alloy
82+
[contributing]: https://op-rs.github.io/maili
83+
84+
[maili-protocol]: https://crates.io/crates/maili-protocol
85+
[maili-provider]: https://crates.io/crates/maili-provider

book/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# `op-alloy-book`
1+
# `maili-book`
22

3-
This repository contains the source code for the op-alloy book, which is available at [alloy-rs.github.io/op-alloy](https://alloy-rs.github.io/op-alloy/).
3+
This repository contains the source code for the maili book, which is available at [op-rs.github.io/maili](https://op-rs.github.io/maili/).
44

55
## Contributing
66

book/book.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ authors = ["refcell"]
33
language = "en"
44
multilingual = false
55
src = "src"
6-
title = "The op-alloy Book"
6+
title = "The maili Book"
77

88
[preprocessor.mermaid]
99
command = "mdbook-mermaid"
@@ -15,7 +15,7 @@ command = "mdbook-mermaid"
1515
[output.html]
1616
default-theme = "ferra"
1717
preferred-dark-theme = "ferra"
18-
git-repository-url = "https://github.com/alloy-rs/op-alloy"
19-
edit-url-template = "https://github.com/alloy-rs/op-alloy/edit/main/book/{path}"
18+
git-repository-url = "https://github.com/op-rs/"
19+
edit-url-template = "https://github.com/op-rs/maili/edit/main/book/{path}"
2020
additional-css = ["custom.css"]
2121
additional-js = ["mermaid.min.js", "mermaid-init.js"]

book/src/CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ Before working with this repository locally, you'll need to install a few depend
3535
The [OP Stack][op-stack] is a set of standardized open-source specifications
3636
that powers Optimism, developed by the Optimism Collective.
3737

38-
`op-alloy` is a rust implementation of core OP Stack types, transports,
39-
middleware and more. Not all types and implementation details in `op-alloy`
38+
`maili` is a rust implementation of distinguished OP Stack types, transports,
39+
middleware and more. Not all types and implementation details in `maili`
4040
are present in the OP Stack [specs][specs], and on the flipside, not all
41-
specifications are implemented by `op-alloy`. That said, `op-alloy` is
41+
specifications are implemented by `maili`. That said, `maili` is
4242
entirely _based off_ of the [specs][specs], and new functionality or
43-
core modifications to `op-alloy` must be reflected in the [specs][specs].
43+
core modifications to `maili` must be reflected in the [specs][specs].
4444

4545
As such, the first step for introducing changes to the OP Stack is to
4646
[open a pr][specs-pr] in the [specs repository][specs-repo]. These
@@ -49,7 +49,7 @@ implementations of the OP Stack are able to synchronize and implement
4949
the changes.
5050

5151
Once changes are merged in the OP Stack [specs][specs] repo, they
52-
may be added to `op-alloy` in a **backwards-compatible** way such
52+
may be added to `maili` in a **backwards-compatible** way such
5353
that pre-upgrade functionality persists. The primary way to enable
5454
backwards-compatibility is by using timestamp-based activation for
5555
protocol upgrades.
@@ -62,5 +62,5 @@ protocol upgrades.
6262
[specs-pr]: https://github.com/ethereum-optimism/specs/pulls
6363
[specs]: https://specs.optimism.io/
6464
[op-stack]: https://docs.optimism.io/stack/getting-started
65-
[book]: https://github.com/alloy-rs/op-alloy/tree/main/book
66-
[new-issue]: https://github.com/alloy-rs/op-alloy/issues/new
65+
[book]: https://github.com/op-rs/maili/tree/main/book
66+
[new-issue]: https://github.com/op-rs/maili/issues/new

book/src/LICENSE.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
# Licensing
22

3-
op-alloy is dually licensed under the [Apache 2.0][apache] and the [MIT][mit] license.
3+
maili is dually licensed under the [Apache 2.0][apache] and the [MIT][mit] license.
44

5-
The [SNAPPY license][snappy] is added for the use of [snap][snap] in `op-alloy-rpc-types-engine`.
6-
7-
[snap]: https://github.com/BurntSushi/rust-snappy
8-
[snappy]: https://github.com/alloy-rs/op-alloy/blob/main/SNAPPY-LICENSE
9-
[apache]: https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-APACHE
10-
[mit]: https://github.com/alloy-rs/op-alloy/blob/main/LICENSE-MIT
5+
[apache]: https://github.com/op-rs/maili/blob/main/LICENSE-APACHE
6+
[mit]: https://github.com/op-rs/maili/blob/main/LICENSE-MIT

book/src/building/README.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,16 @@
11
# Building
22

3-
This section offers in-depth documentation into the various `op-alloy` crates.
3+
This section offers in-depth documentation into the various `maili` crates.
44
Some of the primary crates and their types are listed below.
55

6-
- [`op-alloy-genesis`][op-alloy-genesis] provides the
7-
[`RollupConfig`][rollup-config] and [`SystemConfig`][system-config] types.
8-
- [`op-alloy-consensus`][op-alloy-consensus] provides [`OpBlock`][op-block],
9-
[`OpTxEnvelope`][op-tx-envelope], [`OpReceiptEnvelope`][op-rx-envelope],
10-
[`Hardforks`][hardforks], and more.
11-
- [`op-alloy-rpc-types-engine`][op-alloy-rpc-types-engine] provides the
12-
[`OpPayloadAttributes`][op-payload-attributes] and
13-
[`OpAttributesWithParent`][op-attributes-with-parent].
14-
- [`op-alloy-protocol`][op-alloy-protocol] provides [`Frame`][frame],
6+
- [`maili-protocol`][maili-protocol] provides [`Frame`][frame],
157
[`Channel`][channel], [`Batch`][batch] types and more.
168

179

1810
<!-- Links -->
1911

20-
[rollup-config]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/rollup/struct.RollupConfig.html
21-
[system-config]: https://docs.rs/op-alloy-genesis/latest/op_alloy_genesis/system/struct.SystemConfig.html
12+
[frame]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Frame.html
13+
[channel]: https://docs.rs/maili-protocol/latest/maili_protocol/struct.Channel.html
14+
[batch]: https://docs.rs/maili-protocol/latest/maili_protocol/enum.Batch.html
2215

23-
[op-block]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/type.OpBlock.html
24-
[op-tx-envelope]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpTxEnvelope.html
25-
[op-rx-envelope]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/enum.OpReceiptEnvelope.html
26-
[hardforks]: https://docs.rs/op-alloy-consensus/latest/op_alloy_consensus/hardforks/struct.Hardforks.html
27-
28-
[op-payload-attributes]: https://docs.rs/op-alloy-rpc-types-engine/latest/op_alloy_rpc_types_engine/struct.OpPayloadAttributes.html
29-
[op-attributes-with-parent]: https://docs.rs/op-alloy-rpc-types-engine/latest/op_alloy_rpc_types_engine/struct.OpAttributesWithParent.html
30-
31-
[frame]: https://docs.rs/op-alloy-protocol/latest/op_alloy_protocol/struct.Frame.html
32-
[channel]: https://docs.rs/op-alloy-protocol/latest/op_alloy_protocol/struct.Channel.html
33-
[batch]: https://docs.rs/op-alloy-protocol/latest/op_alloy_protocol/enum.Batch.html
34-
35-
[op-alloy-genesis]: https://crates.io/crates/op-alloy-genesis
36-
[op-alloy-consensus]: https://crates.io/crates/op-alloy-consensus
37-
[op-alloy-protocol]: https://crates.io/crates/op-alloy-protocol
38-
[op-alloy-rpc-types-engine]: https://crates.io/crates/op-alloy-rpc-types-engine
16+
[maili-protocol]: https://crates.io/crates/maili-protocol

0 commit comments

Comments
 (0)