diff --git a/Justfile b/Justfile index a0f8446..10f5d1f 100644 --- a/Justfile +++ b/Justfile @@ -3,11 +3,16 @@ alias t := test alias f := fmt alias l := lint alias b := build +alias opt8n := run # default recipe to display help information default: @just --list +# Runs opt8n +run: + cargo run --bin opt8n + # Run all tests tests: test test-docs diff --git a/README.md b/README.md index c7f5cae..0b288a9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,58 @@ -# op-test-vectors +
+ What's OP Test Vectors? • + Overview • + Contributing • + Credits +
+ +## What's OP Test Vectors? + +OP Test Vectors is a portable suite of standardized test fixtures used to test OP Stack component implementations. + +Test fixtures are static JSON files defined in the [fixtures](./fixtures) directory. + +Test fixtures can be easily generated using the [opt8n](./crates/opt8n) cli tool. + +### Development Status + +`op-test-vectors` is currently in active development, and is not yet ready for use in production. + +## Overview + +**`op-test-vectors`** + +- [`execution`](./crates/op-test-vectors/src/execution.rs): Rust types for the execution test fixtures. +- [`derivation`](./crates/op-test-vectors/src/derivation.rs): Rust types for the derivation test fixtures. + +**`opt8n` Commands** + +- `repl`: Spins up a REPL that allows the user to send transactions to and generate a test fixture from those transactions. +- `script`: Executes a forge script against an anvil instance and generates the test fixture. + +## Book + +The [book][book] contains an in-depth overview of the project, contributor guidelines, and tutorials for creating your own test fixtures as well as you own test runners. + +## Credits + +`op-test-vectors` is inspired by [ethereum/tests][eth-tests] and built by the collaboration between a number of teams and external contributors including [OP Labs][op-labs] and [Worldcoin engineers][worldcoin]. + +[book]: https://ethereum-optimism.github.io/op-test-vectors/ +[op-labs]: https://github.com/ethereum-optimism +[worldcoin]: https://github.com/worldcoin +[eth-tests]: https://github.com/ethereum/tests diff --git a/assets/op-tests.png b/assets/op-tests.png new file mode 100644 index 0000000..7941389 Binary files /dev/null and b/assets/op-tests.png differ