op-alloy

[!IMPORTANT]

This repository is moving to ethereum-optimism/optimism.

The alloy-rs/op-alloy repository will be archived (deprecated). All future development will continue in the new location. Your GitHub contributions will be preserved.

Built on [Alloy][alloy], op-alloy aggregates the OP stack's unique primitives from [Maili][maili], to the subset of L1 types used by Optimistic rollups.

Usage

The following crates are provided by op-alloy:

| Crate Name | Description / Purpose | Version | |-------------|-----------------------------------------|---------| | op-alloy-consensus | Handles consensus-related logic | | | op-alloy-network | Manages networking functionality | | | op-alloy-rpc-jsonrpsee | RPC implementation using jsonrpsee | | | op-alloy-rpc-types-engine | Type definitions specific to RPC engine | | | op-alloy-rpc-types | Shared types used across RPC components | |

Development Status

op-alloy is currently in active development, and is not yet ready for use in production.

Supported Rust Versions (MSRV)

The current MSRV (minimum supported rust version) is 1.86.

Unlike Alloy, op-alloy may use the latest stable release, to benefit from the latest features.

The MSRV is not increased automatically, and will be updated only as part of a patch (pre-1.0) or minor (post-1.0) release.

Contributing

op-alloy is built by open source contributors like you, thank you for improving the project!

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

Pull requests will not be merged unless CI passes, so please ensure that your contribution follows the linting rules and passes clippy.

no_std

op-alloy is intended to be no_std compatible, initially for use in [kona][kona].

The following crates support no_std. Notice, provider crates do not support no_std compatibility.

| Crate Name | Description / Purpose | Version | |----------------------------------------------------------|-----------------------------------------|---------| | [op-alloy-consensus] | Handles consensus-related logic | | | [op-alloy-rpc-types] | Shared types used across RPC components | | | [op-alloy-rpc-types-engine] | RPC types specific to the engine API | |

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

Credits

op-alloy is inspired by the work of several teams and projects, most notably [the Alloy project][alloy].

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

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in these crates by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[check-no-std]: ./scripts/checknostd.sh

[maili]: https://github.com/op-rs/maili [kona]: https://github.com/op-rs/kona [alloy]: https://github.com/alloy-rs/alloy [contributing]: https://alloy-rs.github.io/op-alloy

[op-alloy-consensus]: https://crates.io/crates/op-alloy-consensus [op-alloy-network]: https://crates.io/crates/op-alloy-network [op-alloy-rpc-jsonrpsee]: https://crates.io/crates/op-alloy-rpc-jsonrpsee [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