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: README Cleanup #33

Merged
merged 2 commits into from
Jul 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
5 changes: 5 additions & 0 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
54 changes: 52 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,53 @@
# op-test-vectors
<h1 align="center">
<img src="./assets/op-tests.png" alt="OP Test Vectors" width="200px" align="center">
</h1>

Cli tool for building OP test vectors
<h4 align="center">
Standard Tests for OP Stack Component Implementations.
</h4>

<p align="center">
<a href="https://github.com/ethereum-optimism/op-test-vectors/actions/workflows/ci.yml"><img src="https://github.com/ethereum-optimism/op-test-vectors/actions/workflows/ci.yml/badge.svg?label=ci" alt="CI"></a>
<a href="https://github.com/ethereum-optimism/op-test-vectors/actions/workflows/book.yml"><img src="https://github.com/ethereum-optimism/op-test-vectors/actions/workflows/book.yml/badge.svg?label=Book" alt="Book"></a>
<img src="https://img.shields.io/badge/License-MIT-green.svg?label=license&labelColor=2a2f35" alt="License">
<a href="https://ethereum-optimism.github.io/op-test-vectors"><img src="https://img.shields.io/badge/Contributor%20Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
</p>

<p align="center">
<a href="#whats-op-test-vectors">What's OP Test Vectors?</a> •
<a href="#overview">Overview</a> •
<a href="https://static.optimism.io/op-test-vectors/CONTRIBUTING.html">Contributing</a> •
<a href="#credits">Credits</a>
</p>

## 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`**

- [`client`](./bin/client): The bare-metal program that runs on top of a [fault proof VM][g-fault-proof-vm].
- [`host`](./bin/host): The host program that runs natively alongside the FPVM, serving as the [Preimage Oracle][g-preimage-oracle] server.
refcell marked this conversation as resolved.
Show resolved Hide resolved

## 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
Binary file added assets/op-tests.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.