Skip to content
This repository was archived by the owner on Jan 31, 2025. It is now read-only.

Commit aa8be77

Browse files
authored
Merge pull request #76 from ethereum-optimism/rf/chore/doc-update
chore(docs): Update top-level Readme
2 parents 6f76ea5 + 3494a19 commit aa8be77

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,32 @@ Each has it's own cli tool to generate test fixtures. [opt8n](./bin/opt8n) can b
3838

3939
**`op-test-vectors`**
4040

41+
A rust crate exposing types used to generate test fixtures in [./fixtures](./fixtures/).
42+
43+
`op-test-vectors` contains two primary modules:
44+
4145
- [`execution`](./crates/op-test-vectors/src/execution.rs): Rust types for the execution test fixtures.
4246
- [`derivation`](./crates/op-test-vectors/src/derivation.rs): Rust types for the derivation test fixtures.
4347

44-
**`opt8n` Commands**
48+
**`opt8n`**
49+
50+
A binary to generate execution test fixtures.
51+
52+
`opt8n` has two subcommands:
4553

4654
- `repl`: Spins up a REPL that allows the user to send transactions to and generate a test fixture from those transactions.
4755
- `script`: Executes a forge script against an anvil instance and generates the test fixture.
4856

57+
**`opdn`**
58+
59+
A binary to generate derivation test fixtures.
60+
61+
`opdn` has the following subcommands:
62+
63+
- `from-l2`: Generates a derivation test fixture from the specified range of L2 blocks.
64+
- `from-l1`: Generates a derivation test fixture from the specified range of L1 blocks.
65+
- `info`: Outputs the L2 block info including the L1 origin for the given L2 block number.
66+
4967
## Book
5068

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

0 commit comments

Comments
 (0)