Skip to content

Commit

Permalink
chore(docs): Update top-level readme
Browse files Browse the repository at this point in the history
  • Loading branch information
refcell committed Aug 23, 2024
1 parent 6f76ea5 commit 3494a19
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,32 @@ Each has it's own cli tool to generate test fixtures. [opt8n](./bin/opt8n) can b

**`op-test-vectors`**

A rust crate exposing types used to generate test fixtures in [./fixtures](./fixtures/).

`op-test-vectors` contains two primary modules:

- [`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**
**`opt8n`**

A binary to generate execution test fixtures.

`opt8n` has two subcommands:

- `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.

**`opdn`**

A binary to generate derivation test fixtures.

`opdn` has the following subcommands:

- `from-l2`: Generates a derivation test fixture from the specified range of L2 blocks.
- `from-l1`: Generates a derivation test fixture from the specified range of L1 blocks.
- `info`: Outputs the L2 block info including the L1 origin for the given L2 block number.

## 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.
Expand Down

0 comments on commit 3494a19

Please sign in to comment.