sui CLAUDE.md

CLAUDE.md

Crate-specific CLAUDE.md files

When a sub-crate's CLAUDE.md conflicts with this file, the sub-crate's instructions win.

Individual Preferences

Individual preferences supersede and extend project preferences:

• @CLAUDE.local.md if present.

Essential Development Commands

License comments

All applicable source code files must start with the following license in comments at the top of the file:

Copyright (c) Mysten Labs, Inc.
SPDX-License-Identifier: Apache-2.0

Building and Installation

# Build a specific crate. Generally don't need to do release build.
cargo build -p sui-core

# Check code without code generation or linking (preferred)
cargo check

Testing

# Run e2e tests. simtests must be run with `cargo simtest` to avoid false negatives
cargo simtest -p sui-e2e-tests

# Run Rust unittests. skip simulation tests as they may cause false negatives with `cargo nextest`
SUI_SKIP_SIMTESTS=1 cargo nextest run -p <crate-name>

Important Notes for Testing:

• When compiling or running tests in this repository, set timeout limits to at least 10 minutes due to the large codebase size
• For faster iteration, use -p to select only the most relevant packages for testing. Use multiple -p flags if necessary, e.g. cargo nextest run -p sui-types -p sui-core
• Use cargo nextest run --lib to run only library tests and skip integration tests for faster feedback
• Use a scoped cargo insta test for the relevant package when snapshots are affected. Inspect the generated snapshot diffs. If they match the intended changes, update them with cargo insta accept. Do not accept unrelated snapshot changes.
• Consult crate-specific CLAUDE.md files for instructions on which tests to run, when changing files in those crates

Linting and Formatting

# Formats & lints all Rust & Move (can be slow).
./scripts/lint.sh

# For formatting:
cargo fmt --all

# Lint a single crate in `crates/`, `consensus/`, `sui-execution/`:
cargo xclippy -p <crate-name>

# Linting all crates in `external-crates/`: cd into the crate directory and run:
cargo move-clippy