-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### Description Updates the `op-alloy` readme, following the layout of [alloy](https://github.com/alloy-rs/alloy).
- Loading branch information
Showing
1 changed file
with
88 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,99 @@ | ||
# OP-Alloy | ||
# op-alloy | ||
|
||
Optimism [alloy](https://github.com/alloy-rs/alloy) types. | ||
<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> | ||
<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> | ||
<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> | ||
<a href="https://alloy-rs.github.io/op-alloy"><img src="https://img.shields.io/badge/Contributor%20Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a> | ||
|
||
#### License | ||
Transports, Middleware, and Networks for Optimism built with [Alloy][alloy]. | ||
|
||
|
||
## Usage | ||
|
||
The following crates are provided by `op-alloy`. | ||
|
||
- [`op-alloy-consensus`][op-alloy-consensus] | ||
- [`op-alloy-genesis`][op-alloy-genesis] | ||
- [`op-alloy-network`][op-alloy-network] | ||
- [`op-alloy-protocol`][op-alloy-protocol] | ||
- [`op-alloy-provider`][op-alloy-provider] | ||
- [`op-alloy-rpc-jsonrpsee`][op-alloy-rpc-jsonrpsee] | ||
- [`op-alloy-rpc-types-engine`][op-alloy-rpc-types-engine] | ||
- [`op-alloy-rpc-types`][op-alloy-rpc-types] | ||
|
||
|
||
## Supported Rust Versions (MSRV) | ||
|
||
The current MSRV (minimum supported rust version) is 1.81. | ||
|
||
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 to help you get started to contribute to op-alloy. | ||
|
||
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. | ||
|
||
- `op-alloy-consensus` | ||
- `op-alloy-genesis` | ||
- `op-alloy-protocol` | ||
- `op-alloy-genesis` | ||
- `op-alloy-rpc-types` | ||
- `op-alloy-rpc-types-engine` | ||
|
||
If you would like to add no_std support to a crate, | ||
please make sure to update [scripts/check_no_std.sh][check-no-std]. | ||
|
||
|
||
## Credits | ||
|
||
op-alloy is inspired by the work of several teams and projects, most notably [the Alloy project][alloy]. | ||
|
||
op-alloy would not be possible without the contributions from open source contributors. Thank you. | ||
|
||
|
||
## License | ||
|
||
<sup> | ||
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version | ||
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option. | ||
</sup> | ||
|
||
<br> | ||
|
||
<sub> | ||
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. | ||
</sub> | ||
|
||
<!-- Hyperlinks --> | ||
|
||
[check-no-std]: ./scripts/check_no_std.sh | ||
|
||
[contributing]: https://alloy-rs.github.io/op-alloy | ||
|
||
[kona]: https://github.com/anton-rs/kona | ||
|
||
[alloy]: https://github.com/alloy-rs/alloy | ||
|
||
[op-alloy-consensus]: https://crates.io/crates/op-alloy-consensus | ||
[op-alloy-genesis]: https://crates.io/crates/op-alloy-genesis | ||
[op-alloy-network]: https://crates.io/crates/op-alloy-network | ||
[op-alloy-protocol]: https://crates.io/crates/op-alloy-protocol | ||
[op-alloy-provider]: https://crates.io/crates/op-alloy-provider | ||
[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 |