Solidity Style Guide

Solidity Style Guide

  Consistent. Safe. Gas-aware.
  A practical style guide for modern Solidity, tracking 0.8.34, ERC-7201 namespaced storage, EIP-1153 transient storage, and current Foundry conventions.

Why this guide

Solidity gives you enough rope to ship fast or to lose funds. The official style guide covers formatting; this one covers the patterns that prevent audit findings and waste gas.

- One canonical source. Every rule has a ✅ Yes and a ❌ No example.
- Modern Solidity. Pinned to 0.8.34. Covers transient storage, custom errors in require, ERC-7201, and Pectra-era defaults.
- Copy-paste tooling. A matching Solhint config, a Prettier config, an EditorConfig, and a GitHub Actions workflow.
- Foundry-first testing. Naming matrix, invariants, fuzz, fork tests.
- Editor integrations. Context files for Cursor, Claude Code, and any agent that reads AGENTS.md or llms.txt.

At a glance

Quick start

Drop the configs into your project, install two dev dependencies, and you're linting and formatting in under a minute.

Editor integrations (click to expand)

Claude Code — drop the bundled skill into .claude/skills/, then call it by name.

Cursor, Codex, Aider — they pick up AGENTS.md and .cursorrules automatically once the files sit at the repo root.

Any LLM-backed tool — point it at llms.txt for a token-efficient index of the rules and configs.

Table of contents

- Solidity Style Guide
  - At a glance
  - Quick start
  - Introduction
    - Purpose and Scope
    - Evolution of the Guide
    - Consistency over Correctness
  - General Coding Conventions
    - Indentation and Spacing
      - Indentation Rules
      - Tabs or Spaces
      - Blank Lines
      - Maximum Line Length
      - Source File Encoding
    - Use the Latest Version of Solidity
    - Imports
  -…