Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 1.06 KB

Contributing

Thanks for wanting to contribute! 💛

Dependencies

To work in this repo, you'll need to install:

  1. Rust Toolchain
  2. Docker
  3. ripgrep
  4. mprocs

And clone the Optimism Monorepo

Getting Started

  1. Clone the repo
git clone [email protected]:clabby/op-challenger.git
  1. Configure your dev environment
# Set the MONOREPO_DIR variable
nvim start_devnet.sh
# On the L1 service, port forward the websocket endpoint port (8546)
nvim $MONOREPO_DIR/ops-bedrock/docker-compose.yml
# Start the devnet
./start_devnet.sh
  1. Start the op-challenger with information, warning, and error traces enabled. There are 4 levels of log verbosity, with -vvvv showing all log levels.
cargo run --bin op-challenger -- -vv

Linting

To lint your code, run:

cargo +nightly fmt -- && cargo +nightly clippy --all --all-features -- -D warnings