https://github.com/ethereum-optimism/axos
Portable no-std Derivation Pipeline engineered in pure Rust
https://github.com/ethereum-optimism/axos
crates evm no-std op-st rust
Last synced: about 1 year ago
JSON representation
Portable no-std Derivation Pipeline engineered in pure Rust
- Host: GitHub
- URL: https://github.com/ethereum-optimism/axos
- Owner: ethereum-optimism
- License: mit
- Created: 2023-11-16T18:39:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-21T16:16:41.000Z (over 2 years ago)
- Last Synced: 2024-10-28T17:38:43.418Z (over 1 year ago)
- Topics: crates, evm, no-std, op-st, rust
- Language: Rust
- Homepage: https://crates.io/crates/axos
- Size: 2.8 MB
- Stars: 27
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# axos
[![CI Build Status]][actions]
[![Release]][actions]
[![Tag Build Status]][actions]
[![License]][mit-license]
[![Docs]][Docs-rs]
[![Latest Version]][crates.io]
[![no_std supported][no_std]][nostd]
[![rustc 1.72.1+]][Rust 1.72.1]
[CI Build Status]: https://img.shields.io/github/actions/workflow/status/ethereum-optimism/axos/ci.yml?branch=main&label=build
[Tag Build Status]: https://img.shields.io/github/actions/workflow/status/ethereum-optimism/axos/tag.yml?branch=main&label=tag
[Release]: https://img.shields.io/github/actions/workflow/status/ethereum-optimism/axos/release.yml?branch=main&label=release
[actions]: https://github.com/ethereum-optimism/axos/actions?query=branch%3Amain
[Latest Version]: https://img.shields.io/crates/v/axos.svg
[crates.io]: https://crates.io/crates/axos
[rustc 1.72.1+]: https://img.shields.io/badge/rustc_1.72.1+-lightgray.svg
[Rust 1.72.1]: https://blog.rust-lang.org/2023/09/19/Rust-1.72.1.html
[License]: https://img.shields.io/badge/license-MIT-7795AF.svg
[mit-license]: https://github.com/ethereum-optimism/axos/blob/main/LICENSE.md
[Docs-rs]: https://docs.rs/axos/
[Docs]: https://img.shields.io/docsrs/axos.svg?color=319e8c&label=docs.rs
[no_std]: https://img.shields.io/badge/no__std-tested-green.svg
[nostd]: https://docs.rust-embedded.org/book/intro/no-std.html#summary
[refcell]: https://axos.refcell.org
**Portable no-std Derivation Pipeline engineered in pure Rust** https://github.com/ethereum-optimism/axos/labels/alpha
**[Install](#usage)**
| [Usage](#usage)
| [Development](#developing)
| [Crate Docs][crates.io]
| [Specs][refcell]
| [Reference][Docs-rs]
| [Contributing](#contributing)
| [License](#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][crates.io].
Add it to your project with [`cargo add`](https://github.com/rust-lang/cargo/tree/master/src/cargo/ops/cargo_add).
```text
cargo add axos
```
## Developing
To get started locally, make sure to have [`just`][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][fmt].
- *clippy*: Lints all targets with [clippy][clippy]. (all features)
- *tests*: Runs all workspace tests with [nextest][nextest]. (all features)
To run the `axos` derivation pipeline as a binary, there is a convenience
binary crate `axt`, inside [`./bins/`][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`.
[bins]: ./bins/
[nextest]: https://github.com/nextest-rs/nextest
[clippy]: https://github.com/rust-lang/rust-clippy
[fmt]: https://github.com/rust-lang/rustfmt
[just]: https://github.com/casey/just
## 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](https://github.com/ethereum-optimism/axos/issues/new)
if no relevant issue already exists.
## License
Fully licensed under the [MIT License](LICENSE.md).