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: update README #8

Merged
merged 5 commits into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions .config/zepter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,13 @@ workflows:
# Check that `A` activates the features of `B`.
"propagate-feature",
# These are the features to check:
"--features=std,serde,arbitrary",
"--features=std",
# Do not try to add a new section into `[features]` of `A` only because `B` expose that feature. There are edge-cases where this is still needed, but we can add them manually.
"--left-side-feature-missing=ignore",
# Ignore the case that `A` it outside of the workspace. Otherwise it will report errors in external dependencies that we have no influence on.

"--left-side-outside-workspace=ignore",
# Auxilary flags:
"--offline",
"--locked",
# limit to the workspace
"--workspace",
"--show-path",
"--quiet",
]
Expand All @@ -31,11 +29,10 @@ workflows:
# Will be displayed when any workflow fails:
help:
text: |
Reth uses the Zepter CLI to detect abnormalities in Cargo features, e.g. missing propagation.
Alloy uses the Zepter CLI to detect abnormalities in Cargo features, e.g. missing propagation.

It looks like one more checks failed; please check the console output.

You can try to automatically address them by installing zepter (`cargo install zepter --locked`) and simply running `zepter` in the workspace root.
links:
- "https://github.com/paradigmxyz/reth/pull/11888"
- "https://github.com/ggwpez/zepter"
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# :construction: This repository is a work in progress.

# Alloy-EVM

## Overview

Contains EVM abstractions compatible with types from the alloy ecosystem.
Comes with batteries included for block execution.
Compatible with no_std and riscv targets.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's keep L7 in, I tink no-std and riscv compat should be a goal

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

he has it below

`alloy-evm` is an abstraction layer on top of [revm](https://github.com/bluealloy/revm) providing common implementations of EVMs. Currently, alloy-evm is only used in Reth but is designed to be consumed by any project that needs to execute transactions or blocks on EVM compatible chains.
klkvr marked this conversation as resolved.
Show resolved Hide resolved

#### License

Expand Down
3 changes: 2 additions & 1 deletion crates/op-evm/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ default = ["std"]
std = [
"alloy-primitives/std",
"derive_more/std",
"revm/std"
"revm/std",
"alloy-evm/std"
]
optimism = ["revm/optimism"]