axos

Portable no-std Derivation Pipeline engineered in pure Rust https://github.com/ethereum-optimism/axos/labels/alpha

Install | Usage | Development | Crate Docs | Specs | Reference | Contributing | License

What is axos?

Portable no-std Derivation Pipeline engineered in pure Rust.

Usage

axos is meant to be used as a library with cargo. Add it to your project with cargo add.

cargo add axos

Developing

To get started locally, make sure to have just installed. This will allow you to get up and running by executing the just command in the root of the axos repository. This will run the following Justfile targets:

• fmt: Formats all rust files with rustfmt.
• clippy: Lints all targets with clippy. (all features)
• tests: Runs all workspace tests with nextest. (all features)

To run the axos derivation pipeline as a binary, there is a convenience binary crate axt, inside ./bins/, that can run axos using mock data, an offline provider, or with live chain data. Just run axt in mock provider mode using the axt target: just axt.

Contributing

Contributions to axos are welcome and highly appreciated.

When opening a pull request or issue, please provide concise and descriptive detail such that anyone with little context reading your issue or reviewing your pull request can easily understand and provide meaningful feedback.

Before opening a pull request, make sure all tests pass. Execute just to run the default Justfile target, which formats, lints, and tests all rust files in the cargo workspace. If the just command succeeds locally, ci will likely pass in your pull request.

Troubleshooting

Please check existing issues for similar bugs or open an issue if no relevant issue already exists.

License

Fully licensed under the MIT License.